Edit

Referral Export via API

API setups can range from easy plug-and-play integrations, to advanced two-phase integrations with custom field mapping. Regardless, given the intricacies of One Platform and the sensitivity of these integrations, referral API setups should always be completed by the operations team.

Before You Begin

Be sure you have all the required API setup information first, such as the production and/or testing endpoint, authentication, and any required parameters.

Setting Up the API Connection

1. Navigate to the correct account in One Platform.

2. Click on 'Connections' in the bottom left menu.

   

3. Click on Add connection.

   

4. Click on 'API' tile under Referrals.

   

5. Give your connection a name.

   

6. Enter the endpoint for your connection.

   

7. Enter all the required information under Authorization, Headers and Body.

   

8. Enter all your 'Response handling' rules.

   

Testing Your API Connection

1. Once your API connection is setup (endpoint, authorization, headers, body and response handling) click on 'Settings'.

   

2. Edit the testing settings according to your test criteria.

   

3. Click on 'Save'.

   

4. Click on 'Test'.

   

5. Check your test result.

6. Repeat tests until you've achieved your desired outcomes.

Linking Campaigns to Your API Connection

1. Go to Real-time Referral page.

2. Expand the Connection that you want to link a campaign to.

   

3. Click on 'Show unlinked'.

   

4. Find the campaign that you want to link to your connection and click on 'LINK'.

   

5. The campaign is now linked to your connection.

   

Unlinking Campaigns From Your API Connection

1. Go to Real-time Referral page.

2. Expand the Connection that you want to link a campaign to.

   

3. Find the campaign that you want to unlink to your connection and click on 'UNLINK'.

   

4. Click on 'Show unlinked'.

   

5. Confirm that your campaign is now unlinked from your connection.