Referral Hero Documentation
Getting StartedFeaturesIntegration
  • Introduction to ReferralHero
  • Getting Started
    • Quickstart
    • Creating a New Campaign
      • Choose a Campaign Type
      • Set Your Goals
      • Define a Unique Identifier
      • Set Up Integrations
      • Set Up Automations
      • Configure Options
  • Features
    • Subscribers
      • Types Of Subscribers
  • Integrations
    • Overview
    • Embeddable Widgets
      • Advocate Dashboard Widget
      • Referral Signup Widget
      • Referral Welcome Banner
      • Sharing Widget
      • Floating Button
      • Customize the Widgets
    • Javascript Web API
      • Getting Started
      • Configuration File
      • Callbacks
      • Add a Subscriber
      • Add a Pending Referral
      • Track multi-step conversion events
      • Track Transaction
      • Identify a Subscriber
      • Identify a Referrer
      • Generate Dashboard Widget
      • Generate Sharing-Screen
    • React JS
    • Platform Specific Integration
      • Shopify
      • Webflow
      • WordPress
    • Mobile SDK's
      • React Native
        • Getting Started
        • Mobile App Testing in Development Mode
    • REST API
      • Lists
        • 🟠POST lists
        • 🟢GET lists
        • 🟢GET lists/:uuid/leaderboard
        • 🟢GET lists/:uuid/bonuses
    • API Tutorials
Powered by GitBook
On this page
  • Getting started with Postman
  • ​Introduction
  • Import the collection
  • Use the collection
  • Select an endpoint
  • Add values to the Params tab
  • Send your request and review your response
  1. Integrations

API Tutorials

PreviousGET lists/:uuid/bonuses

Last updated 2 months ago

Getting started with Postman

In this , we will discuss what Postman is and how to quickly get set up with it.

Introduction

Postman is a desktop and web application that allows you to make requests to an API from a graphical user interface. We recommend using Postman when exploring the APIs functionality,

We currently have one Postman collections available:

Import the collection

To begin, you need to access the Postman app. You can use either the browser or desktop version. After launching the app, import the collection.

To start this process on the web, press the Import button at the top-left corner, followed by the Link option. Insert the link. If you’re using the Postman desktop app, click File > Import. After successfully importing, the collection appears under Collections.

To use the collection, navigate to the collection you just imported and click Variables. Copy your Authorization key & campaign uuid from the referralhero account, and paste it into the Initial Value fields. After you complete this step, you’re ready to begin making requests. Each endpoint will automatically include the parameters, so you just need to add your credentials and parameter values to start exploring the functionality.

Select an endpoint

Next step is to choose an endpoint from the collection and start to build your request. You can select an endpoint from the right-hand side navigation. Here is what this looks like:

Next step will have you navigate to the Params tab. You should see a set of params with descriptions that explain what the parameter does, and a list of all of the potential values that you can pass with your request.

Send your request and review your response

Now that everything is set up in your request, you can click the “Send” button & review your responses.

Use the collection

Add values to the Params tab

​

Mobile API Collection

Mobile collection
For this example, we are going to use the Mobile API > Track Referral endpoint.