partner
GET /v1/partner/customers/{externalId}
Read one of your customers' links.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу partner.domains; кључ без ње се одбија уз 403, а не 404.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/partner/customers/{externalId} \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
The organization you may act on, the state of the link, and whether a registrant contact is on file yet. A customer of another partner is a 404, never a 403. 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… |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
external_id | string | Да | — |
org_id | string | Да | The organization you may act on, as X-Zinn-Org. Empty while the link is not active — a pending link names no organization you may use. |
state | string<active, pending_consent, revoked> | Да | — |
created_org | boolean | Да | Whether we made this organization for you, or the customer already had one. |
has_registrant | boolean | Да | Whether a registrant contact is on file. An order is refused until it is. |
email | string | Да | — |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 429