syndication
POST /v1/syndication/connections
Connect a social account.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی 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