syndication

POST `/v1/syndication/connections`

Connect a social account.

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

چیرته چې ستاسو د سازمان آی ډي ځي

دا پای ټکی د پوښتنې پیرامیتر په توګه 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 کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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 n…

د غوښتنې بدن

نوم	ډول	اړین	دا څه شی دی
`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