connections
POST /v1/connections/{provider}
Validate or store a provider access token.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу connections.manage; кључ без ње се одбија уз 403, а не 404.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/connections/{provider} \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
With validate_only the token is checked and nothing is stored, and the result is returned with 200 even when the token is invalid — an invalid token is an answer the caller renders, not a request error. Without it the token is re-validated and then stored in Vault, returning 201; a token that fails validation is rejected with TOKEN_INVALID and never persisted. The token itself is never logged or echoed. Requires connections.manage.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
provider (path) | ConnectionProvider | Да | The third-party provider whose connections are addressed. |
org_id (query) | Uuid | Не | Which organization this connected account belongs to. Required when the caller manages connections for more than one — a reseller or an agency by construction — because a… |
Idempotency-Key (header) | string | Не | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
valid | boolean | Да | — |
account_login | object | Да | The account the token authenticates as, when valid. |
scopes | string[] | Да | — |
missing_scopes | string[] | Да | Required scopes the token lacks. Empty when the token is valid, and also empty when the provider could not enumerate its permissions — in that case the connection is usable but… |
message | object | Да | Human-readable explanation, or null when valid. |
permissions | PermissionReport | null | Не | The per-permission checklist, exercised against the provider. ⛔ null means we cannot test this provider's permissions — it does not mean "nothing is required". The two… |
Грешке које ова крајња тачка може вратити
401 · 403 · 422 · 429 · 503