affiliate

GET `/v1/affiliate`

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

Autenticazione

Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.

L'ID della tua organizzazione va qui

Questo endpoint accetta org_id come parametro di query. Omettilo e la chiamata coprirà l'intero sottoalbero del tuo tenant; invialo per limitare la chiamata a una singola organizzazione.

L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`org_id (query)`	`string`	No	—

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`account`	`AffiliateAccount`	Sì	—
`totals`	`AffiliateTotals`	Sì	—
`plans`	`AffiliateCommissionPlan[]`	Sì	—

Errori che questo endpoint può restituire

401 · 403 · 404