Autentificare
Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.
Unde merge ID-ul organizației tale
Acest punct final acceptă org_id ca parametru de interogare. Omiteți-l și apelul va acoperi întregul subarbore al chiriașului dvs.; trimiteți-l pentru a restrânge apelul la o singură organizație.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X POST https://api.zinndigital.com/v1/affiliate \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "commission_plan": <string<recurring_12m, lifetime>>, "payout_destination": <string<wallet, cash>>, "accept_terms": <boolean> }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
Gated on `affiliate.manage`. The account lands `pending` and accrues nothing until staff approve it — otherwise the programme is an open invitation to self-refer at scale. Choosing cash payouts sets `kyc_state` to `required`; wallet credit needs no verification because the money never leaves the platform.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
org_id (query) | string | Nu | — |
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
commission_plan | string<recurring_12m, lifetime> | Da | — |
payout_destination | string<wallet, cash> | Da | — |
accept_terms | boolean | Da | Must be `true`. An affiliate agreement is a contract about money, so acceptance is recorded explicitly rather than assumed. |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
id | string | Da | — |
org_id | string | Da | — |
state | string<pending, approved, rejected, suspended> | Da | — |
code | string | Da | The referral code. Its alphabet excludes the characters people transcribe wrongly (`0`/`O`, `1`/`I`/`l`), because it is read aloud and typed off a slide. |
referral_url | string | Da | The link to share — the public site with `?ref=CODE`. |
commission_plan | string<recurring_12m, lifetime> | Da | The line **new** referrals will be created on. Changing it never affects customers already referred. |
payout_destination | string<wallet, cash> | Da | — |
kyc_state | string<not_required, required, submitted, verified, rejected> | Da | — |
review_note | string | Nu | — |
terms_accepted_at | string | Nu | — |
applied_at | string | Nu | — |
Erori pe care le poate returna acest punct final
401 · 403 · 409 · 422