connections

POST /v1/connections/{provider}

Validate or store a provider access token.

Sve connections krajnje tačke

Autentifikacija

Pošaljite API ključ kao bearer token. Ključ mora imati dozvolu connections.manage; ključ bez nje se odbija sa 403, a ne sa 404.

Gde ide ID vaše organizacije

Ova krajnja tačka prihvata org_id kao parametar upita. Izostavite ga i poziv obuhvata celokupno stablo vašeg zakupca; pošaljite ga da biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na ekranu sa API ključevima u vašoj kontrolnoj tabli, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamenite bilo šta u uglastim zagradama sopstvenim vrednostima, a ključni placeholder sa ključem sa vaše kontrolne table.

curl -X POST https://api.zinndigital.com/v1/connections/{provider} \
  -H "Authorization: Bearer zdk_live_…"

Prijavljeni ste? API konzola na vašoj kontrolnoj tabli automatski popunjava ID vaše stvarne organizacije i vaš sopstveni ključ, i izvršava zahtev nad API-jem uživo tako da možete videti stvarni odgovor. Otvorite ovu krajnju tačku u API konzoli

Detalji

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`.

Parametri

NazivVrstaObaveznoŠta je ovo
provider (path)ConnectionProviderDaThe third-party provider whose connections are addressed.
org_id (query)UuidNeWhich 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 creden…
Idempotency-Key (header)stringNeClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Odgovor

NazivVrstaObaveznoŠta je ovo
validbooleanDa
account_loginobjectDaThe account the token authenticates as, when valid.
scopesstring[]Da
missing_scopesstring[]DaRequired 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…
messageobjectDaHuman-readable explanation, or null when valid.
permissionsPermissionReport | nullNeThe 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 rea…

Greške koje ovaj krajnji tačka može da vrati

401 · 403 · 422 · 429 · 503