syndication
POST /v1/syndication/connections/{connectionId}/verify
Check a connection against the live channel.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織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