API traffic

  • Zaktualizowano

API traffic can work for affiliate programs of banks and other financial institutions that aim to get requests for financial services, such as loan granting, card issue, making deposits, etc.

What is special about API traffic is that the publisher acquires user requests on their ad space and then conveys them to the advertiser via API. This way, the publisher acts as a broker—a mediator between you and the user.
 

How it works

    1. The publisher creates a landing page and deploys a request form there, tailored to the financial service described in the program.
      The request form contains some required fields as prescribed by the program.
      Under the form, there is a checkbox that the user needs to flag to show they agree to transfer and processing of their personal data.


    2. The user comes to the landing page, specifies their personal data in the form, and submits the request.

    3. From the publisher's ad space, the filled request is conveyed to the Admitad Affiliate server via API.
      Admitad Affiliate verifies that the fields are filled out correctly and the user agreed to personal data processing. After that, the request is transferred to your server via API.

    4. You review the request. If it meets action requirements and program rules, you confirm the action and pay the publisher their reward.

If the request does not meet the requirements and/or the rules, you can decline it.
 

How to get started with API traffic

To start using API traffic, you need a running Admitad affiliate program that stipulates the rules for publishers and ad space and traffic specifications.

Contact your account manager and provide the following details to enable API traffic:

    1. Request registration URL.
      Provide a link to which Admitad Affiliate will send user requests.

    2. Authentication. Username/password or key to sign requests.
      This is a string by which the server will understand the request was received from Admitad Affiliate and needs acceptance.

    3. Required fields in the form.
      Specify what user information the publisher must collect and what characters are allowed.

    4. Payable action.
      Finance programs usually employ one of the standard actions:
Action Payment model Description
Request created CPL The user has submitted a request for a loan, insurance, credit card, etc.
Request confirmed CPL The user has submitted a request and it was approved by the advertiser call center.
Request approved CPL The user has submitted a request and the advertiser approved it.
Confirmed request ≠ approved request.
By confirming a request the advertiser only verifies receipt. On the other hand, by approving a request the advertiser attributes it to the publisher.
Loan granted/card issued CPA The user has taken a loan or gotten a card.

5. API documentation, examples of requests, and responses.

Your account manager will forward all these data to the Admitad Affiliate tracking department specialists who will set up API traffic.
 

How API requests are displayed in reports

API requests are recorded in reports just like ordinary actions by affiliate links.

Features:

  1. Admitad Affiliate reports only reflect approved API requests.
    The approved status means the request was reviewed by Admitad Affiliate and transferred to your system via API. At the moment when your server transmits the request ID to the Admitad Affiliate report in response, you confirm that the request was registered in your system.
  2. A click is an event when the Admitad Affiliate server receives the API request.
  3. Click time is the moment when the Admitad Affiliate server received the request.
  4. An action is an event when the advertiser registers the request.
  5. Action time is the time when the advertiser receives the request.
  6. On hold is the status the request is assigned after receipt; it will keep it until you decline or confirm it.
     

How to control the number of requests from publishers

Set limits in the program to control the number of inbound API requests. There are two types of limits:

    1. Program’s general limit.
      Use this type if you need to restrict the total number of requests your program can receive every day from all publishers.

    2. Limits for certain publishers or ad spaces.
      Use this limit to restrict the number of requests for a certain publisher or publishers.

You can combine limits. For instance, you can set both a general limit and complement it with a limit for a specific publisher.

Once the number of requests reached the threshold value, publishers will not be able to transfer requests until the next day.

By default, limits apply to all requests provided by the publishers.
But you can set them so they only apply to requests verified by Admitad Affiliate and successfully received by your server.

If you need to set limits for your program, ask your account manager for help. They will adjust your program’s settings accordingly.

Czy ten artykuł był pomocny?