Uthibitishaji
Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya reseller.manage; ufunguo usio nayo unakataliwa kwa 403, si 404.
Mahali ambapo kitambulisho cha shirika lako huwekwa
Kigezo hiki kinachukua org_id kama kigezo cha utafutaji. Iache wazi na simu itashughulikia tawi lako lote la wapangaji; itume ili kupunguza simu iwe ya shirika moja tu.
Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.
Jaribu
Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.
curl -X POST https://api.zinndigital.com/v1/reseller/dunning \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "steps": <DunningStep[]>, "reason": <string> }'Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API
Maelezo
Publishing, never editing. A ladder changed while customers are halfway up it must not change what those customers were already told, so every save is a new immutable version and runs already climbing keep the one they started on. A 422 carries the validator's own sentence, naming which rung is wrong and why - a `warn` whose grace disagrees with the next rung would tell a customer a deadline that is not the deadline. Requires `reseller.manage`.
Vigezo
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
org_id (query) | Uuid | Hapana | Which of your organizations this applies to. Required only when you belong to more than one here - otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
Mwili wa ombi
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
steps | DunningStep[] | Ndiyo | — |
reason | string | Ndiyo | Why it changed. Required: a ladder decides when a paying customer is suspended, and a version with no reason is one nobody can explain a year later. |
Majibu
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
using_platform_default | boolean | Ndiyo | True when the reseller has published no ladder of their own. `active_version` then carries the PLATFORM rungs their clients are chased on today, so the screen never has to rende… |
max_total_days | integer | Ndiyo | The longest a whole ladder may run. A hard coupling, not a preference: the rebill workflow's execution timeout is derived from it, and a longer ladder would be terminated mid-cl… |
active_version | DunningPolicyVersion | Ndiyo | The ladder in force. On the platform-default view this is synthesised rather than read from a row, so `id` is null and `version` is 0. |
versions | DunningPolicyVersion[] | Ndiyo | Every version this reseller has published, newest first. |
Hitilafu ambazo mwisho huu unaweza kurudisha
401 · 403 · 404 · 422 · 429