syndication
POST /v1/syndication/connections/{connectionId}/verify
Check a connection against the live channel.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.
ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/syndication/connections/{connectionId}/verify \
-H "Authorization: Bearer zdk_live_…"შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი API კონსოლში
დეტალები
⛔ A failure is a **200 carrying a non-ready `status`**, not an error response — "we could not reach it" is the answer to the question that was asked. Three outcomes: `ready`, `needs_reconnect` (the customer must act) and `error` (we reached the vendor and it said no for another reason). Gated on `syndication.manage`.
პარამეტრები
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
connectionId (path) | string | დიახ | — |
პასუხი
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
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 · 404