affiliate
GET /v1/affiliate/referrals
The customers who signed up through your links.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте сұрау параметрі ретінде org_id мәнін қабылдайды. Оны бос қалдырсаңыз, шақыру бүкіл жалға алушы тармағын қамтиды; шақыруды бір ұйымға шектеу үшін оны жіберіңіз.
Сіздің ұйым идентификаторыңыз басқару панеліндегі API кілттері экранында, кілттің өзінің жанында орналасқан. Бұл сіз жасайтын әрбір шақырудағы бірдей идентификатор.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X GET https://api.zinndigital.com/v1/affiliate/referrals \
-H "Authorization: Bearer zdk_live_…"Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз
Мәліметтер
Gated on `affiliate.view`. Each row carries the commission terms **as they were when that customer converted** — `plan`, `rate_bps` and `duration_months` are a snapshot, not a copy of your current line, so the screen shows what each referral actually earns.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
org_id (query) | string | Жоқ | — |
limit (query) | integer | Жоқ | — |
offset (query) | integer | Жоқ | — |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
items | AffiliateReferral[] | Иә | — |
total | integer | Иә | — |
limit | integer | Иә | — |
offset | integer | Иә | — |
Бұл соңғы нүкте қайтара алатын қателер
401 · 403 · 404