syndication

POST `/v1/syndication/connections`

Connect a social account.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Nazwa	Typ	Wymagane	Co to jest
`org_id (query)`	`string`	Nie	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 n…

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`channel`	`string`	Tak	—
`name`	`string`	Tak	—
`credentials`	`object`	Tak	Every value the channel's `fields` name. The secret half goes to Vault and is never returned.
`byo`	`boolean`	Nie	—

Odpowiedź

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

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 422