syndication

POST `/v1/syndication/connections`

Connect a social account.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

Název	Typ	Požadováno	Co to je
`org_id (query)`	`string`	Ne	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…

Tělo požadavku

Název	Typ	Požadováno	Co to je
`channel`	`string`	Ano	—
`name`	`string`	Ano	—
`credentials`	`object`	Ano	Every value the channel's `fields` name. The secret half goes to Vault and is never returned.
`byo`	`boolean`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`string`	Ano	—
`channel`	`string`	Ano	—
`name`	`string`	Ano	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`	Ano	The non-secret half — a handle, an instance, a board id.
`status`	`string<unverified, ready, needs_reconnect, error>`	Ano	⛔⛔ `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`	Ano	The account the VENDOR said this credential belongs to — discovered.
`verify_error`	`string`	Ano	A machine code the dashboard turns into copy. Never a sentence.
`verified_at`	`string`	Ano	—
`expires_at`	`string`	Ano	⛔ `null` means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
`byo`	`boolean`	Ano	Whether the customer supplied their own developer app.
`created_at`	`string`	Ano	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 422