connections
POST /v1/connections/{provider}
Validate or store a provider access token.
Tabbatar da Asali
Aika maɓallin API azaman alamar ɗauka (bearer token). Dole ne maɓallin ya kasance yana da izinin connections.manage; idan babu shi, za a ƙi amfani da maɓallin tare da lambar 403, ba 404 ba.
Inda ID ɗin kungiyar ku ke zuwa
Wannan mahadar ta na daukar org_id a matsayin sigar tambaya. Bar shi kuma kiran zai shafi daukacin rukunin haya naka; aika shi don takaita kiran zuwa kungiya daya tak.
Ana samun lambar kungiyar ku a kan shafin maɓallan API a cikin madanninku, kusa da maɓallin kansa. Shi ne lambar da ta dace a kowane kiran da kuka yi.
Gwada
May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.
curl -X POST https://api.zinndigital.com/v1/connections/{provider} \
-H "Authorization: Bearer zdk_live_…"An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API
Bayani
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.
Sigogi
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
provider (path) | ConnectionProvider | Eh | The third-party provider whose connections are addressed. |
org_id (query) | Uuid | A'a | 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 | A'a | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Martani
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
valid | boolean | Eh | — |
account_login | object | Eh | The account the token authenticates as, when valid. |
scopes | string[] | Eh | — |
missing_scopes | string[] | Eh | 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 | Eh | Human-readable explanation, or null when valid. |
permissions | PermissionReport | null | A'a | 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… |
Kuskuren da wannan matsaya za ta iya maido wa
401 · 403 · 422 · 429 · 503