connections
POST /v1/connections/{provider}
Validate or store a provider access token.
身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 connections.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
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 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