syndication

POST `/v1/syndication/connections`

Connect a social account.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

A szervezet azonosítójának helye

Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

curl -X POST https://api.zinndigital.com/v1/syndication/connections \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "channel": <string>, "name": <string>, "credentials": <object> }'

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

Stores the credential in Vault and the pointer on the row, then probes it immediately so the customer learns now whether it works rather than when their next article publishes. Gated on syndication.manage, which is a separate key from links.edit because this posts publicly on the customer's own brand accounts.

Paraméterek

Név	Típus	Kötelező	Mi ez
`org_id (query)`	`string`	Nem	Which organisation to connect it for, within the caller's subtree. ⛔ Scoped by `syndication.manage`, never by the reading key — a member holding only view on a client org must not…

Kérés törzse

Név	Típus	Kötelező	Mi ez
`channel`	`string`	Igen	—
`name`	`string`	Igen	—
`credentials`	`object`	Igen	Every value the channel's `fields` name. The secret half goes to Vault and is never returned.
`byo`	`boolean`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`id`	`string`	Igen	—
`channel`	`string`	Igen	—
`name`	`string`	Igen	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`	Igen	The non-secret half — a handle, an instance, a board id.
`status`	`string<unverified, ready, needs_reconnect, error>`	Igen	⛔⛔ `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`	Igen	The account the VENDOR said this credential belongs to — discovered.
`verify_error`	`string`	Igen	A machine code the dashboard turns into copy. Never a sentence.
`verified_at`	`string`	Igen	—
`expires_at`	`string`	Igen	⛔ `null` means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
`byo`	`boolean`	Igen	Whether the customer supplied their own developer app.
`created_at`	`string`	Igen	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 422