API Reference

Base URL, authentication, request/response envelope, and available endpoints for the Affitor Tracking API.

The Affitor Tracking API lets your backend record affiliate events — clicks, signups, sales, and refunds — and retrieve program performance data.

Base URL

https://api.affitor.com

All paths below are relative to this base. Strapi serves v1 routes under /api, so the full path for a tracking endpoint is:

https://api.affitor.com/api/v1/track/sale

:::note A machine-readable OpenAPI 3.1 spec is available for the tracking endpoints — import it into Postman, Insomnia, code generators, or an AI coding agent. :::

Authentication

Different endpoints use different auth modes.

Endpoint	Auth required	How to pass
`POST /api/v1/track/click`	None	No token needed
`POST /api/v1/track/lead`	Optional (server mode)	`Authorization: Bearer <program_api_key>`
`POST /api/v1/track/sale`	Required	`Authorization: Bearer <program_api_key>`
`POST /api/v1/track/refund`	Required	`Authorization: Bearer <program_api_key>`

Your program API key (api_token) is found in the Affitor dashboard under your program settings.

Server mode vs browser mode (lead endpoint)

POST /api/v1/track/lead supports two modes:

Browser mode — called by affitor-tracker.js from the customer's browser. No Bearer token. Attribution is proved by the click_id cookie value passed in the body.
Server mode — called from your backend. Include Authorization: Bearer <program_api_key>. Pass customer_key or click_id to identify the customer.

Response envelope

All endpoints return JSON. A successful response always includes "success": true. Error responses include an "error" string.

Success shape:

{
  "success": true
}

Sale and refund responses include additional IDs:

{
  "success": true,
  "sale_id": 42,
  "commission_id": 17,
  "message": "Sale tracked successfully"
}

Error shape:

{
  "error": "transaction_id is required and must be a string"
}

Endpoint families

`/api/v1/track/*` — Tracking API (v1)

The primary integration surface. Writes to the v1 event tables (affiliate_click_events, affiliate_lead_events, affiliate_sale_events).

Method	Path	Purpose
`POST`	`/api/v1/track/click`	Record an affiliate link click
`POST`	`/api/v1/track/lead`	Record a customer signup
`POST`	`/api/v1/track/sale`	Record a completed sale and create a commission
`POST`	`/api/v1/track/refund`	Reverse the commission for a previously tracked sale