# API Tutorials

## Getting started with Postman <a href="#getting-started-with-postman" id="getting-started-with-postman"></a>

This document will discuss what Postman is and how to quickly get set up with it.

### [​](https://docs.x.com/tutorials/postman-getting-started#introduction)Introduction <a href="#introduction" id="introduction"></a>

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:

<table data-view="cards"><thead><tr><th align="center"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center">Mobile API Collection</td><td><a href="https://www.postman.com/referral-hero/mobile-api/collection/uvwwcd6/mobile-apis">https://www.postman.com/referral-hero/mobile-api/collection/uvwwcd6/mobile-apis</a></td></tr></tbody></table>

### Import the collection![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg) <a href="#import-collection" id="import-collection"></a>

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](https://api.postman.com/collections/38599485-faa7d699-ec23-4fc3-a43a-3895bbff8872?access_key=PMAT-01JMEXHX6WKTA4QCDVBQEWRJYJ) link. If you’re using the Postman desktop app, click **File > Import**. After successfully importing, the collection appears under **Collections**.

<figure><img src="https://berylsystems.gitbook.io/~gitbook/image?url=https%3A%2F%2F1427773792-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FhQxsg0xCpG1doJ626L8X%252Fuploads%252FIl6svv0HhFrMy3d5auKR%252FScreenshot%25202025-02-18%2520at%25202.22.57%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3D199e14f9-2fae-4d38-af0c-808e2a992057&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=95ca320d&#x26;sv=2" alt="" width="375"><figcaption></figcaption></figure>

### Use the collection![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg) <a href="#use-collection" id="use-collection"></a>

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.

<figure><img src="https://berylsystems.gitbook.io/~gitbook/image?url=https%3A%2F%2F1427773792-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FhQxsg0xCpG1doJ626L8X%252Fuploads%252F9cVhva46aElBtE3CvqGh%252FScreenshot%25202025-02-19%2520at%25203.34.49%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3Dddf7a6fc-9d22-4b54-a966-9b7721f0076a&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=35a55c&#x26;sv=2" alt=""><figcaption></figcaption></figure>

### Select an endpoint <a href="#step-three-select-an-endpoint" id="step-three-select-an-endpoint"></a>

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.

<figure><img src="https://berylsystems.gitbook.io/~gitbook/image?url=https%3A%2F%2F1427773792-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FhQxsg0xCpG1doJ626L8X%252Fuploads%252FaJDfYzXM3hFsWccP9vdo%252FScreenshot%25202025-02-18%2520at%25202.54.12%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3D1289d3a7-b12d-4377-a0f7-cddc818f95e8&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=7a51dbe2&#x26;sv=2" alt="" width="375"><figcaption></figcaption></figure>

### Add values to the Params tab![](https://b.stripecdn.com/docs-statics-srv/assets/fcc3a1c24df6fcffface6110ca4963de.svg) <a href="#use-collection-1" id="use-collection-1"></a>

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.

<figure><img src="https://berylsystems.gitbook.io/~gitbook/image?url=https%3A%2F%2F1427773792-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FhQxsg0xCpG1doJ626L8X%252Fuploads%252FRmAFDhzUyDMdkLr1kNtc%252FScreenshot%25202025-02-18%2520at%25202.52.10%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3Dfc688876-c971-42cf-a666-ceedc34681b3&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=9e373c1b&#x26;sv=2" alt=""><figcaption></figcaption></figure>

### **Send your request and review your response** <a href="#send-your-request-and-review-your-response" id="send-your-request-and-review-your-response"></a>

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

<figure><img src="https://berylsystems.gitbook.io/~gitbook/image?url=https%3A%2F%2F1427773792-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FhQxsg0xCpG1doJ626L8X%252Fuploads%252FuTgS01PPu6QZsNjkDAkO%252FScreenshot%25202025-02-18%2520at%25203.00.06%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3D6bfefa3c-e313-4894-97c6-fa0a091eddef&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=4e3961c3&#x26;sv=2" alt=""><figcaption></figcaption></figure>
