syndication
POST /v1/syndication/connections/{connectionId}/verify
Check a connection against the live channel.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/syndication/connections/{connectionId}/verify \
-H "Authorization: Bearer zdk_live_…"已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
⛔ A failure is a 200 carrying a non-ready status, not an error response — "we could not reach it" is the answer to the question that was asked. Three outcomes: ready, needs_reconnect (the customer must act) and error (we reached the vendor and it said no for another reason). Gated on syndication.manage.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
connectionId (path) | string | 是 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | string | 是 | — |
channel | string | 是 | — |
name | string | 是 | The customer's own name for it. ⛔ name on the wire, label on the model: Field.label is DRF's own attribute and shadowing it is silent at runtime. |
target | string | 是 | The non-secret half — a handle, an instance, a board id. |
status | string<unverified, ready, needs_reconnect, error> | 是 | ⛔⛔ needs_reconnect is NOT a failure — the credential lapsed and only the customer can fix it. unverified means we have not looked, which is a third fact and not a quiet green. |
account_ref | string | 是 | The account the VENDOR said this credential belongs to — discovered. |
verify_error | string | 是 | A machine code the dashboard turns into copy. Never a sentence. |
verified_at | string | 是 | — |
expires_at | string | 是 | ⛔ null means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green. |
byo | boolean | 是 | Whether the customer supplied their own developer app. |
created_at | string | 是 | — |
此端点可能返回的错误
401 · 403 · 404