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 Rokt operations team.
Before you begin
Be sure you have all the required API setup information first, including the environment endpoints, authentication, and any required parameters.
Setting up the API connection
Navigate to your account in One Platform.
Click Connections in the bottom left menu.
Click Add connection.
Under Referrals, click API.
Give your connection a name.
Enter the endpoint for your connection.
Enter all the required information under Authorization, Headers, and Body.
Enter all your Response handling rules.
Testing your API connection
Once your API connection is set up (endpoint, authorization, headers, body, and response handling), click Settings.
Edit the testing settings according to your test criteria.
Click Save.
Click Test.
Check your test result.
Repeat tests until you've achieved your desired outcome.
Linking campaigns to your API connection
Go to the Real-time Referral page.
Expand the connection that you want to link a campaign to.
Click Show unlinked.
Find the campaign that you want to link to your connection and click Link.
The campaign is now linked to your connection.
Unlinking campaigns from your API connection
Go to the Real-time Referral page.
Expand the connection that you want to link a campaign to.
Find the campaign that you want to unlink from your connection and click Unlink.
Click Show unlinked.
Confirm that your campaign is now unlinked from your connection.
