hosting
POST /v1/sites/{siteId}/cms-target/test
Check the credential actually works, against the real CMS.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/cms-target/test \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Contacts the site's CMS with the stored credential and records what happened. Gated on `links.edit`. ⭐ **This is what promotes a target from "configured" to "ready".** A preset we shipped from a vendor's documentation is a claim; a probe against the customer's own instance is a measurement, and nothing in the picker reads green until this has answered. ⛔ A failure here is a 200 carrying `reachable: false` and a reason, not an error status. "We could not reach it" is the answer to the question that was asked.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
siteId (path) | string | بله | — |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
site_id | string | بله | — |
reachable | boolean | بله | — |
identity | string | بله | — |
code | string | بله | — |
detail | string | بله | — |
suitability | string<ready, needs_setup, unknown, unsuitable, blocked> | بله | — |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404