syndication
POST /v1/syndication/connections/{connectionId}/verify
Check a connection against the live channel.
توثيقِ شناخت
ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔
یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
curl -X POST https://api.zinndigital.com/v1/syndication/connections/{connectionId}/verify \
-H "Authorization: Bearer zdk_live_…"لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو 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