affiliate

GET `/v1/affiliate`

Your affiliate account, your earnings, and the lines you can choose from.

Authenticatie

Stuur een API-sleutel mee als bearer token. Dit eindpunt vermeldt geen specifieke toestemming in de specificatie, dus geef uw sleutel de minimale rechten die nodig zijn en controleer het antwoord in plaats van zomaar wat aan te nemen.

Waar je organisatie-id komt te staan

Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

curl -X GET https://api.zinndigital.com/v1/affiliate \
  -H "Authorization: Bearer zdk_live_…"

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

Gated on `affiliate.view`. Answers `200` with `account: null` when this organisation has not joined — "you are not an affiliate yet" is a normal state of a screen every customer can open, not an error. `totals.by_currency` is grouped by currency and deliberately **not** summed across them: adding 100 GBP to 100 EUR produces a number that is wrong in both. `plans` is served from the engine rather than hardcoded in a console, so a rate the owner changes cannot disagree with the rate a customer read before signing up.

Parameters

Naam	Type	Verplicht	Wat dit is
`org_id (query)`	`string`	Nee	—

Reactie

Naam	Type	Verplicht	Wat dit is
`account`	`AffiliateAccount`	Ja	—
`totals`	`AffiliateTotals`	Ja	—
`plans`	`AffiliateCommissionPlan[]`	Ja	—

Fouten die dit eindpunt kan retourneren

401 · 403 · 404