hosting
POST /v1/sites/{siteId}/cms-target/test
Check the credential actually works, against the real CMS.
Uthibitishaji
Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.
Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.
Jaribu
Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/cms-target/test \
-H "Authorization: Bearer zdk_live_…"Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API
Maelezo
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.
Vigezo
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
siteId (path) | string | Ndiyo | — |
Majibu
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
site_id | string | Ndiyo | — |
reachable | boolean | Ndiyo | — |
identity | string | Ndiyo | — |
code | string | Ndiyo | — |
detail | string | Ndiyo | — |
suitability | string<ready, needs_setup, unknown, unsuitable, blocked> | Ndiyo | — |
Hitilafu ambazo mwisho huu unaweza kurudisha
401 · 403 · 404