Affiliate API Overview
Table of Contents
Affiliate Overview
Roamify Affiliate API for a partner is straightforward and easy to use. You only need to follow a few steps to integrate Roamify Affiliate API into your application and start earning commissions on every sale you make.
Customer must click your referral link to be able to track the sale and reward you with the commission regardless of promo code used.
- Step 1: Authentication: You need to have your Access Token to make requests to Roamify eSIM API. You can get your Access Token from Roamify Partner Portal .
- Step 2: Get eSIM Packages: You will be assigned a dedicated endpoint to get a list of eSIM packages, which included all available eSIM packages and your referral link for each package.
- Step 3: Present to Customers: You can present the eSIM packages to your customers using the referral link you received in the previous step.
- Step 4: Track rewards: You can track your rewards in the Roamify Partner Portal. You will see how many sales you made, how much commission you earned, and more.
Recommended steps to use Affiliate API
Step 1: Authentication
You need to have your Access Token to make requests to Roamify eSIM API. You can get your Access Token from Roamify Partner Portal .
If you don’t have an account, you can sign up here or contact us at support@getroamify.com.
Our token is a Bearer token, which means you need to include it in the Authorization
header of your requests.
Step 2: Get eSIM Packages
With your dedicated endpoint, you can get a list of eSIM packages that are available for you to promote.
You need to send a GET
request to the /api/esim/{unique name}/packages
endpoint.
This endpoint will return a list of all available eSIM packages with referral links for each package.
The referral link will include your unique identifier, which will be used to track the sales you make.
Usage - how to get eSIM packages
Here is an example of how you can get a list of eSIM packages using Roamify eSIM API.
curl
curl --request GET \
--url 'https://api-dev.getroamify.com/api/esim/esimradar/packages' \
--header 'Authorization: Bearer Access Token' \
--header 'Content-Type: application/json'
You can read more about this endpoint here.
Step 3: Present to Customers
Once you have the list of eSIM packages, you can then find each country’s eSIM options in the packages array of the response.
- Red box indicates the country name and code.
- Yellow box indicates the eSIM packages available for that country.
- Blue box indicates the referral link for each package.
Step 4: Track rewards
You can track your rewards in the Roamify Partner Portal. You will see how many sales you made, how much commission you earned, and more.
- Red box click to withdraw your earnings.
- Yellow box click to view your earnings history.
- Blue box click to add or update your bank account details for payouts.
The End
That’s it! You have successfully integrated Roamify Affiliate API into your application. If you have any questions or need help, feel free to contact us at support@getroamify.com.