11010 – Register user to an Affiliate Commission Program via API

Each affiliate commission program now has it’s own custom registration webhook and cancellation webhook. This will allow you to for example register someone to a commission program when you add them to a campaign in your email system.

Setup Affiliate Registration Webhook

In your KLEQ site, go to Affiliates in the left-sidebar menu.
In the next screen, open one of the Commission Programs you would like to edit.

 

In the pop-up that appears, under Registration Webhook, copy the API URL provided.

NB! We also have Secret Key support to prevent somebody else sending registration webhooks to your site. To setup your Secret Key, proceed here.

Once you are done, go back to your Payment or Emailing System. Check with their support team if they support HTTP Post or HTTP Get integrations. If they do then simply setup one of these two options:

Setup a HTTP Post
  • Follow the steps provided by your Payment or Emailing System to send a HTTP Post to your KLEQ site to register an Affiliate to one of your Commission Programs.
  • In Post URL field: Paste the Custom API URL you copied from the Commission Program
  • Then you want to add the following parameter name/value pairs
    i.e. parameter name -> parameter value
    contactEmail -> Insert the client email
    firstName -> Insert the client’s first name
    lastName -> Insert the client’s last name
    (note: if you want to automate this process you can add your system’s merge fields for the client’s email, firstname and lastname).
Setup a HTTP Get
  • Follow the steps provided by your Payment or Emailing System to send a HTTP Get to your KLEQ site to register an Affiliate to one of your Commission Programs.
  • In ‘Get’ URL field: Paste the Custom API URL you copied from the Commission Program.
  • Then you want to add the following parameter name/value pairs to the end of your API URL. Note: How this is done, will depend on the Payment System you are using.

    contactEmail
    -> Insert the client email
    firstName -> Insert the client’s first name
    lastName -> Insert the client’s last name(note: if you want to automate this process you can add your system’s merge fields for the client’s email, firstname and lastname).An example HTTP Get would look something like this:
    https://yourdomainname.com/affiliate.php?ap=2&h=59e99d&secret=E9REkE&contactEmail=ADDEMAILMERGE&firstName=ADDFIRSTNAMEMERGE&lastName=ADDLASTNAMEMERGE

IMPORTANT: There is a limit of 100 requests of registration per minute. This is to protect your site from too many requests. If too many requests are sent, then once the 100 limit cap is reached, any extra requests will be ignored.

Related Article

11011 – Remove user from an Affiliate Commission Program via API