partner
POST /v1/partner/customers/{externalId}/panel-invite
Give your customer a way into their own control panel.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу partner.domains; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/partner/customers/{externalId}/panel-invite \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
Invites the e-mail address the customer is linked with to their organization as its owner, and returns accept_url — send it in your own message. They sign in or sign up with that address and land in their panel; the verified e-mail is the authorisation, so the link is not a secret. A customer who already belongs to the organization gets status: already_member and the panel address. Repeating the call returns the same pending invitation. Requires partner.domains.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
externalId (path) | string | Да | YOUR id for that customer — whatever your own system calls them. It is what makes linking idempotent, and it is scoped to your partner programme: another partner's id is a 404… |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
status | string<invited, already_member> | Да | — |
invitation_id | object | Да | — |
accept_url | string | Да | — |
email | string | Да | — |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 422 · 429