ReferralHero
  • Welcome to the Support Center
  • Common Questions
  • Features
    • Subscribers
      • Subscriber Profile
      • Unique Identifier
      • Active Visitors
      • 'Quick Add' Referral
      • Update Referral Status
    • Campaign Templates
      • Contest
      • Website Referral Analysis
      • Net Promoter Score
    • Unique Identifier
      • Phone Number
      • Confirmation Email
        • Thank-You Page
    • Automations
      • A/B Test
    • Security
      • Manual Review & Confirmation
      • Secondary Verification Method
      • High Risk
      • Blacklist
      • ReCaptcha
    • Reward
      • Reward Status
      • Advanced Reward Options
      • Transactions
    • Analytics
      • Active Visitors
      • Subscribers
      • Sources
      • Shares
      • Devices
      • Unsubscribers
    • Misc
      • Memorable referral links
      • 1-Click Signup
      • Forward & Refer
      • Coupon Codes
      • Custom Attribution
  • Integrate
    • Embeddable Widgets
      • Custom Domain
    • Integrations
      • Active Campaign
      • Aweber
      • Blockchain
      • Facebook Pixel
      • Calendly
      • Discord
      • HubSpot
      • Intercom
      • KakaoTalk
      • Klaviyo
      • Mailchimp
      • Salesforce
      • SendLane
      • Slack
      • Stripe
      • Tango Card
      • Telegram
      • Tremendous
      • Twilio
      • Typeform
      • Webhooks
      • Zapier
      • Zoho
    • Platform-specific Instructions
      • Google Tag Manager
      • WordPress
      • Webflow
      • SquareSpace
      • ClickFunnels
      • Unbounce
      • Instapage
      • Shopify
      • Carrd
      • WIX
    • 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
    • ReactJS
    • REST API
      • Errors
      • Webhooks
      • Objects
      • Endpoint Reference
    • Mobile SDKs
      • iOS SDK
        • Getting Started
        • Public Methods
        • Public Classes
        • API Interaction Methods
      • Android SDK
        • Getting Started
        • Public Methods
        • Public Classes
        • Listeners & Interfaces
      • Flutter SDK
        • Getting Started
        • Public Methods
      • React Native
        • Getting Started
        • Public Methods
        • Mobile App Testing in Development Mode
      • Mobile App Testing in Development Mode
  • 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

Was this helpful?

API Tutorials

PreviousMobile App Testing in Development Mode

Last updated 2 months ago

Was this helpful?

Getting started with Postman

This document 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 request an API from a graphical user interface. We recommend using Postman when exploring the API functionality,

We currently have one Postman collection available:

Import the collection

To begin, you need to access the Postman app. You can use either the browser or the 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

The 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:

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

Navigate to the Params tab in the next step. You should see a set of parameters with descriptions explaining their functions and a list of all 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