10.2 Leads via API

  • API feature allows two systems to communicate and exchange data automatically, without manual input.

  • Types of API tools in Track360:

    • Leads via API: Affiliates send potential customers data (leads) directly into the CRM through Track360.

    • API Reports: External systems can fetch real-time reports and performance data from Track360.

The functionality of Leads via API needs to be available and configured by your tech provider. Please check if the integration exists.

  • Activation of Product’s API integration allows to receive Leads via API:

    • Track360 connects to the CRM to create Leads.

    • The affiliate connects to Track360 the Leads.

    • The affiliate is sending Leads to the CRM through Track360.

  • Navigate into Advertisers & Products > Products

  • Check if the product shows API Integration icon

    • If the product displays the API Integration icon, you can activate the Leads via API for the selected affiliate/IBs.

    • If the product does not display the API Integration icon, you need to contact Track360 Support Team Members to set it up.

Set API Integration on an Affiliate/IB

  • Navigate into Affiliate Management > Manage

  • Select the affiliate or click to the arrow icon on the rightmost of the row. Click on the Open Affiliate Page

  • Navigate into API tab to add API Integration or view the existing ones.

  • API Integrations dropdown provides integration API options for each product already configured, such as Leads or Account Registration APIs.

  • Select the desired API and click Add to enable integration.

  • Once you added, the integrated API will be listed under Existing API Integrations

    • Use the Delete button, to delete the integration of the API for the selected Affiliate/IB

    • Use the Edit button to configure the API access for the particular affiliate/IB.

To edit Existing API Integration for the affiliate/IB, refer to subsection of API on 2.6 Open Affiliate Page

  • API Key gives you the unique token for API integration.

    • To generate the key, click the Plus button and copy the token API value

    • To renew the key, click the Extend Expiry Date button to update its validity.

  • Whitelisted IPs to secure API access. Define the From and To fields to define a range of IP addresses or add a single IP. Then, click Add to save the IP(s) to the whitelist.

    • To allow the full API range, set the minimum (0.0.0.0) and maximum (255.255.255.255). Only set full range if you really want open access.

    • Additionally, find previously added IP ranges in the list with a trashcan icon to delete unwanted entries.

  • Once all API details are configured. Copy the API Key value to provide it to the affiliate/IB.

Testing API

  • The API testing Integration helps verify that Leads are correctly sent to the Affiliate/IB’s CRM.

  • Navigate into Advertisers & Products > Products.

  • Click on the Edit action (pencil icon), on the rightmost side of the row, of the desired Product.

  • On APIs input/output tab, where each row determines an already configured Integration, select the action Click here to test the API on the desired one to test.

  • Choose an already configured affiliate/IB with API Permissions, and select a campaign. The API Token will be automatically filled up.

If the API Token does not fill up it is necessary to go into Affiliate/IB’s Open Page and set the API Authentication. To generate it refer to 10.2 Set API Integration on an Affiliate/IB

  • Fill up the Lead Information details.

  • There are two ways for testing,

Test on Track360

  • Once Integration is selected to test

  • Fill up the Lead Information details.

  • Click test to check the API operation

  • Detailed summary of the API test will be displayed, where:

    • The left panel displays the full HTTP Request body, showing all parameters sent in the test (e.g., email, IP, product ID, campaign ID).

    • The right panel shows the HTTP Response, including status code, response message, and any error returned by the affiliate's API.

  • Once tested, navigate into Reports > Leads via API. Run a report and review if a new row was generated with the Lead test.

  • Check information of Lead test as: affiliate id, campaign, country, email, name or any tracking parameter.

  • Also, check on the Affiliate/IB’s CRM the test was created as a Lead

Test on Postman

  • With Postman the affiliate/IBs do not need extra permissions to test API Integration.

  • The affiliate/IB will be able to quickly adjust lead details on the json body and easily track errors or response details for testing purposes.

  • Provide to the related affiliate/IB the corresponding information:

  • Once Integration is selected to test.

  • Fill up the Lead Information details.

  • Click View as JSON to copy the API body clicking on Copy JSON to Clipboard (this JSON view will be useful needed for the affiliate to test)

  • On the Body tab, as raw and JSON type, paste JSON body of Test API integration of the platform.

  • Test the API clicking on Send and analyse and share the result.

To follow up the leads results, when they became a customer (such a SignUp or FTD), you can:

Set postbacks: Navigate into subsection Pixels/Postbacks, on Open Affiliate Page to set up postbacks to the affiliate/IB, follow up explanation on section 10.1 Postback/Pixel Integration

Leads via API Reports: Logged in as the desired affiliate/IB, navigate into section 10.3 Leads via API Reports to manage all APIs created under their performance.

Last updated