Skip to main content
Use Tapfiliate through Corsair: one client, typed API calls. Create a key in Tapfiliate under Settings, API. Every request sends it as X-Api-Key. A key created for a team member only sees what that member’s permissions allow. Things to know before you call:
  • Tracking references differ per operation. customers.create needs one of coupon, click ID, referral code, asset ID or tracking ID, and source_id only goes with asset_id. conversions.create takes the same references, or customer_id alone when it matches an existing customer in a recurring program (Tapfiliate answers 400 otherwise). clicks.create names the affiliate with referral_code (a source_id beside it overrides the code’s source) or with asset_id plus source_id; a coupon, click ID or tracking ID doesn’t identify a click. The plugin checks these before sending.
  • Ranking when several are sent. Tapfiliate uses only the highest-precedence reference: coupon, then click ID, then referral code, then asset ID with source ID, then tracking ID.
  • A conversion creates commissions. conversions.create creates the regular commission and any MLM level commissions. If you pass commissions, their sub_amounts must add up to amount, and you get one commission per entry instead of the program’s default.
  • Converting an amount does not move the commission. conversions.update changes amount only. Commission amounts change when the call also sends recalculate_commissions: true, which travels as a query flag.
  • Creating an affiliate may answer no body. The reference documents a 200 with no body, so affiliates.create then reports { created: true, email } and the id comes from affiliates.list. When Tapfiliate does return the affiliate with a generated password, store it: it is the only way into the new account.
  • An incomplete address is dropped silently. Tapfiliate keeps an address only when address, postal_code, city and country.code are all present. The plugin requires them together.
  • Approval defaults to yes. programs.addAffiliate approves unless you send approved: false for disapproved or approved: null for pending, and it ignores the program’s auto-approve setting.
  • Coupon updates are three-way. In programs.updateAffiliate, coupon: null removes the coupon, a string replaces it, and leaving the field out changes nothing.
  • Deletes. A 204 answers with no body, so the delete endpoints report { success: true }. payments.cancel is a DELETE route that cancels the payment (the affiliate balance goes back up by its amount, and there is no undo). customers.cancel stops recurring commissions and customers.uncancel restores them.
  • Paging is by page number. Lists return 25 items per page and put the next page in the Link header, which the plugin cannot read with the body, so pass page yourself and keep requesting until a page comes back short.
  • Rate limits and plans. Limits range from 10 to 1500 requests per window per key and endpoint. A 429 carries no Retry-After; the plugin retries three times with backoff. Click routes need the click-report feature, and affiliate groups need a plan that includes them, or they answer 403.
What you get:
  • 41 typed API operations

Setup

1

Install

2

Add the plugin

corsair.ts
With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.
3

Choose authentication

4

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

Example API calls

List the first page of affiliates
Add an affiliate to a program and approve it
See the full list on the API page.

What’s next

API reference

Every tapfiliate.api.* operation with input and output types.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.