affiliate
POST /v1/affiliate
Join the affiliate programme.
Նույնականացում
Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:
Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն
Այs վերջնակետը ընդունում է org_id-ը որպես հարցման պարամետր: Բաց թողեք այն, և կանչը կընդգրկի ձեր ամբողջ վարձակալության ենթածառը. ուղարկեք այն՝ կանչը մեկ կազմակերպության վրա սահմանափակելու համար:
Ձեր կազմակերպության ID-ն գտնվում է Ձեր ղեկավարման վահանակի API բանալիների էկրանին՝ բուն բանալու կողքին: Այն նույն ID-ն է Ձեր կատարած յուրաքանչյուր հարցման մեջ:
Փորձել
Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:
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> }'Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում
Մանրամասներ
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.
Պարամետրեր
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
org_id (query) | string | Ոչ | — |
Հարցման մարմին
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
commission_plan | string<recurring_12m, lifetime> | Այո | — |
payout_destination | string<wallet, cash> | Այո | — |
accept_terms | boolean | Այո | Must be true. An affiliate agreement is a contract about money, so acceptance is recorded explicitly rather than assumed. |
Պատասխան
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
id | string | Այո | — |
org_id | string | Այո | — |
state | string<pending, approved, rejected, suspended> | Այո | — |
code | string | Այո | 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 | Այո | The link to share — the public site with ?ref=CODE. |
commission_plan | string<recurring_12m, lifetime> | Այո | The line new referrals will be created on. Changing it never affects customers already referred. |
payout_destination | string<wallet, cash> | Այո | — |
kyc_state | string<not_required, required, submitted, verified, rejected> | Այո | — |
review_note | string | Ոչ | — |
terms_accepted_at | string | Ոչ | — |
applied_at | string | Ոչ | — |
Այս վերջնակետի կողմից վերադարձվող սխալները
401 · 403 · 409 · 422