syndication

POST `/v1/syndication/connections`

Connect a social account.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Де вказується ідентифікатор вашої організації

Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`org_id (query)`	`string`	Ні	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…

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`channel`	`string`	Так	—
`name`	`string`	Так	—
`credentials`	`object`	Так	Every value the channel's `fields` name. The secret half goes to Vault and is never returned.
`byo`	`boolean`	Ні	—

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`string`	Так	—
`channel`	`string`	Так	—
`name`	`string`	Так	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`	Так	The non-secret half — a handle, an instance, a board id.
`status`	`string<unverified, ready, needs_reconnect, error>`	Так	⛔⛔ `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`	Так	The account the VENDOR said this credential belongs to — discovered.
`verify_error`	`string`	Так	A machine code the dashboard turns into copy. Never a sentence.
`verified_at`	`string`	Так	—
`expires_at`	`string`	Так	⛔ `null` means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
`byo`	`boolean`	Так	Whether the customer supplied their own developer app.
`created_at`	`string`	Так	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 422

POST /v1/syndication/connections