syndication

POST /v1/syndication/connections/{connectionId}/verify

Check a connection against the live channel.

Svi syndication krajnji točke

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

⛔ 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`.

Parametri

NazivVrstaObaveznoŠto je to
connectionId (path)stringDa

Odgovor

NazivVrstaObaveznoŠto je to
idstringDa
channelstringDa
namestringDaThe 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.
targetstringDaThe non-secret half — a handle, an instance, a board id.
statusstring<unverified, ready, needs_reconnect, error>Da⛔⛔ `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_refstringDaThe account the VENDOR said this credential belongs to — discovered.
verify_errorstringDaA machine code the dashboard turns into copy. Never a sentence.
verified_atstringDa
expires_atstringDa⛔ `null` means **no stated expiry**, which is a different fact from "never expires" and must not render as an unqualified green.
byobooleanDaWhether the customer supplied their own developer app.
created_atstringDa

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404