connections
POST /v1/connections/{provider}
Validate or store a provider access token.
પ્રમાણીકરણ
એપીઆઈ કી (API key) ને બેરર ટોકન તરીકે મોકલો. કી પાસે connections.manage પરવાનગી હોવી આવશ્યક છે; તેના વગરની કીને 404 ને બદલે 403 સાથે અસ્વીકાર કરવામાં આવશે.
જ્યાં તમારી સંસ્થા આઈડી જાય છે
આ એન્ડપૉઇન્ટ ક્વેરી પેરામીટર તરીકે org_id લે છે. તેને છોડી દો અને આ કૉલ તમારા આખા ટેનન્સી સબટ્રીને આવરી લેશે; તેને એક સંસ્થા સુધી કૉલ મર્યાદિત કરવા માટે મોકલો.
તમારી સંસ્થાની આઈડી તમારા ડેશબોર્ડ પર API કી સ્ક્રીન પર, કી ની બાજુમાં જ છે. તે તમે કરો છો તે દરેક કૉલમાં સમાન આઈડી છે.
આયમાવો
કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.
curl -X POST https://api.zinndigital.com/v1/connections/{provider} \
-H "Authorization: Bearer zdk_live_…"साइन ઇન કરેલ છે? તમારા ડેશબોર્ડમાં આવેલું API કન્સોલ તમારી વાસ્તવિક સંસ્થાની આઈડી અને તમારી પોતાની કી ભરે છે, અને લાઇવ 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 creden… |
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 rea… |
આ એન્ડપોઇન્ટ જે ભૂલો પરત કરી શકે છે
401 · 403 · 422 · 429 · 503