Edit

Transaction 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, transactions API setups should always be completed by the operations team.

Before you begin

Be sure you have all the required API setup information first including the relevant environment endpoints, authentication method, and any required parameters.

Setting up the API connection

1. Navigate to your account in One Platform.

2. From the left navigation, click Connections.

   

3. Click Add connection.

   

4. Under Transactions, select API.

   

5. Give your connection a name.

   

6. Enter the endpoint for your connection.

   

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

   

8. Enter all your Response handling rules.

   

Testing your real-time connection

1. Once your API connection is set up (endpoint, authorization, headers, body, and response handling), click Settings.

   

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

   

3. Click Save.

4. Click Test.

   

5. Check your test result.

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

Linking placements to your API connection

1. From the Connections page, select Real-time and Transactions from the dropdown.

2. Expand the connection that you want to link your placements to.

   

3. Click Show unlinked.

   

4. Click Link for All Placements.

   

5. All placements are now linked to your connection.

   

Unlinking placements from your API connection

1. From the Connections page, select Real-time and Transactions from the dropdown.

2. Expand the connection that you want to unlink your placements from.

   

3. Click Unlink to unlink all placements.

   

4. All placements are unlinked.