API Tutorials

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:

Mobile API Collection

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 Mobile collection link. If you’re using the Postman desktop app, click File > Import. After successfully importing, the collection appears under Collections.

Use the collection

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.

Add values to the Params tab

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.