syndication
POST /v1/syndication/connections/{connectionId}/verify
Check a connection against the live channel.
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X POST https://api.zinndigital.com/v1/syndication/connections/{connectionId}/verify \
-H "Authorization: Bearer zdk_live_…"Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
⛔ 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`.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
connectionId (path) | string | Ja | — |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | string | Ja | — |
channel | string | Ja | — |
name | string | Ja | 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 | Ja | The non-secret half — a handle, an instance, a board id. |
status | string<unverified, ready, needs_reconnect, error> | Ja | ⛔⛔ `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 | Ja | The account the VENDOR said this credential belongs to — discovered. |
verify_error | string | Ja | A machine code the dashboard turns into copy. Never a sentence. |
verified_at | string | Ja | — |
expires_at | string | Ja | ⛔ `null` means **no stated expiry**, which is a different fact from "never expires" and must not render as an unqualified green. |
byo | boolean | Ja | Whether the customer supplied their own developer app. |
created_at | string | Ja | — |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404