affiliate
POST /v1/affiliate
Join the affiliate programme.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
A szervezet azonosítójának helye
Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
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> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
org_id (query) | string | Nem | — |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
commission_plan | string<recurring_12m, lifetime> | Igen | — |
payout_destination | string<wallet, cash> | Igen | — |
accept_terms | boolean | Igen | Must be true. An affiliate agreement is a contract about money, so acceptance is recorded explicitly rather than assumed. |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | string | Igen | — |
org_id | string | Igen | — |
state | string<pending, approved, rejected, suspended> | Igen | — |
code | string | Igen | 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 | Igen | The link to share — the public site with ?ref=CODE. |
commission_plan | string<recurring_12m, lifetime> | Igen | The line new referrals will be created on. Changing it never affects customers already referred. |
payout_destination | string<wallet, cash> | Igen | — |
kyc_state | string<not_required, required, submitted, verified, rejected> | Igen | — |
review_note | string | Nem | — |
terms_accepted_at | string | Nem | — |
applied_at | string | Nem | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 409 · 422