hosting
POST /v1/sites/{siteId}/cms-target/test
Check the credential actually works, against the real CMS.
Pagpapatotoo
Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/cms-target/test \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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.
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
siteId (path) | string | Oo | — |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
site_id | string | Oo | — |
reachable | boolean | Oo | — |
identity | string | Oo | — |
code | string | Oo | — |
detail | string | Oo | — |
suitability | string<ready, needs_setup, unknown, unsuitable, blocked> | Oo | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404