Quickstart

1. Get your API key

Log in to Tapfiliate and copy your API key from your profile settings. The help center shows where to find it, together with your account ID that tapfiliate.js needs.

Your API key can approve commissions. Keep it on your server: never put it in frontend code, a public repository or a support ticket.

2. Make your first request

List the programs in your account:

curl https://api.tapfiliate.com/1.6/programs/ \
  -H "X-Api-Key: YOUR_API_KEY"

A 200 response with a JSON array of programs means your key works. See Authentication if you get 401 or 403.

3. Track a conversion

Pick the way that matches where you know about the sale.

In the browser
From your server

Add tapfiliate.js to every page so clicks on affiliate links are detected:

<script src="https://script.tapfiliate.com/tapfiliate.js" type="text/javascript" async></script>
<script type="text/javascript">
  (function(t,a,p){t.TapfiliateObject=a;t[a]=t[a]||function(){
  (t[a].q=t[a].q||[]).push(arguments)}})(window,'tap');

  tap('create', 'YOUR_ACCOUNT_ID');
  tap('detect');
</script>

Then report the sale on your thank-you page:

tap('conversion', 'ORD123', 49.99);

The conversion is only created when the visitor came through an affiliate. See JavaScript tracking for customers, trials and multiple commissions.

Send the order with the affiliate’s referral code, coupon or click ID:

curl -X POST https://api.tapfiliate.com/1.6/conversions/ \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "referral_code": "janejameson",
    "external_id": "ORD123",
    "amount": 49.99
  }'

const response = await fetch('https://api.tapfiliate.com/1.6/conversions/', {
  method: 'POST',
  headers: {
    'X-Api-Key': process.env.TAPFILIATE_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    referral_code: 'janejameson',
    external_id: 'ORD123',
    amount: 49.99,
  }),
});

if (!response.ok) {
  throw new Error(`Tapfiliate: ${response.status} ${await response.text()}`);
}
const conversion = await response.json();

import os
import requests

response = requests.post(
    "https://api.tapfiliate.com/1.6/conversions/",
    headers={"X-Api-Key": os.environ["TAPFILIATE_API_KEY"]},
    json={"referral_code": "janejameson", "external_id": "ORD123", "amount": 49.99},
    timeout=10,
)
response.raise_for_status()
conversion = response.json()

$ch = curl_init('https://api.tapfiliate.com/1.6/conversions/');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_HTTPHEADER => [
        'X-Api-Key: ' . getenv('TAPFILIATE_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'referral_code' => 'janejameson',
        'external_id' => 'ORD123',
        'amount' => 49.99,
    ]),
]);
$conversion = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

external_id is your order ID. A second request with the same external_id is rejected with 400 Duplicate conversion, so a retry never counts a sale twice. See Create a conversion for every field.

4. Check it in your dashboard

Open the conversions report in your Tapfiliate dashboard: the conversion appears there with its commission. Run a test like this before you launch your program, so you know tracking works end to end.

Get started

Tracking

Automation

Recipes

AI

1. Get your API key

2. Make your first request

3. Track a conversion

4. Check it in your dashboard

Next steps

API reference

Webhooks

​1. Get your API key

​2. Make your first request

​3. Track a conversion

​4. Check it in your dashboard

​Next steps

API reference

Webhooks

1. Get your API key

2. Make your first request

3. Track a conversion

4. Check it in your dashboard

Next steps