partner
GET /v1/partner/customers/{externalId}/panel-access
Whether your customer can sign in to their control panel yet.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу partner.domains; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/partner/customers/{externalId}/panel-access \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
Read-only. member is true once a user with the e-mail the customer is linked with belongs to the customer's organization. invitation is the newest control-panel invitation for that e-mail (expired when a pending one has passed its expires_at), or null when none was ever sent — send panel-invite. panel_url is the address the customer bookmarks. Requires partner.domains; an unknown or inactive customer is 404. Not audited (it changes nothing).
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
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… |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
member | boolean | Да | The linked e-mail already belongs to the customer's organization. |
email | string | Да | — |
panel_url | string | Да | The control-panel address to give the customer. |
invitation | null | object | Да | — |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 429