connections

POST `/v1/connections/{provider}`

Validate or store a provider access token.

ማረጋገጫ

የAPI ቁልፉን እንደ bearer token ይላኩ። ቁልፉ የconnections.manage ፈቃድ ሊኖረው ይገባል፤ ይህ ፈቃድ የሌለው ቁልፍ በ404 ሳይሆን በ403 ውድቅ ይደረጋል።

የድርጅትዎ መታወቂያ የሚገባበት ቦታ

ይህ ማቆሚያ ነጥብ org_id እንደ ጥያቄ መለኪያ ይወስዳል። እሱን ይተውት እና ጥሪው አጠቃላይ የኪራይ ንዑስ ዛፍዎን ይሸፍናል፤ ጥሪውን ወደ አንድ ድርጅት ለማጥበብ ይላኩት።

የድርጅትዎ መለያ ቁጥር (ID) በዳሽቦርድዎ ላይ በሚገኙት የኤፒአይ ቁልፎች (API keys) ማያ ገጽ ላይ ከቁልፉ አጠገብ ይገኛል። በሚያደርጉት እያንዳንዱ ጥያቄ ላይ የሚጠቀሙበት መለያ ቁጥር አንድ አይነት ነው።

ሞክሩት

በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።

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

ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በ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

POST /v1/connections/{provider}