# API Tutorials

## Getting started with Postman

In this , we 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 make requests to an API from a graphical user interface. We recommend using Postman when exploring the APIs functionality,&#x20;

We currently have one Postman collections 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 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://1427773792-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhQxsg0xCpG1doJ626L8X%2Fuploads%2FIl6svv0HhFrMy3d5auKR%2FScreenshot%202025-02-18%20at%202.22.57%E2%80%AFAM.png?alt=media&#x26;token=199e14f9-2fae-4d38-af0c-808e2a992057" 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://1427773792-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhQxsg0xCpG1doJ626L8X%2Fuploads%2F9cVhva46aElBtE3CvqGh%2FScreenshot%202025-02-19%20at%203.34.49%E2%80%AFAM.png?alt=media&#x26;token=ddf7a6fc-9d22-4b54-a966-9b7721f0076a" alt=""><figcaption></figcaption></figure>

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

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:

<figure><img src="https://1427773792-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhQxsg0xCpG1doJ626L8X%2Fuploads%2FaJDfYzXM3hFsWccP9vdo%2FScreenshot%202025-02-18%20at%202.54.12%E2%80%AFAM.png?alt=media&#x26;token=1289d3a7-b12d-4377-a0f7-cddc818f95e8" alt="" width="372"><figcaption><p>For this example, we are going to use the Mobile API >  Track Referral endpoint.</p></figcaption></figure>

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

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.

<figure><img src="https://1427773792-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhQxsg0xCpG1doJ626L8X%2Fuploads%2FRmAFDhzUyDMdkLr1kNtc%2FScreenshot%202025-02-18%20at%202.52.10%E2%80%AFAM.png?alt=media&#x26;token=fc688876-c971-42cf-a666-ceedc34681b3" alt=""><figcaption></figcaption></figure>

### **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.

<figure><img src="https://1427773792-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhQxsg0xCpG1doJ626L8X%2Fuploads%2FuTgS01PPu6QZsNjkDAkO%2FScreenshot%202025-02-18%20at%203.00.06%E2%80%AFAM.png?alt=media&#x26;token=6bfefa3c-e313-4894-97c6-fa0a091eddef" alt=""><figcaption></figcaption></figure>
