hosting

POST /v1/sites/{siteId}/cms-target/test

Check the credential actually works, against the real CMS.

Све hosting крајње тачке

Сва документација за програмере →

Аутентификација

Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.

Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/cms-target/test \
  -H "Authorization: Bearer zdk_live_…"

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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_idstringДа—
reachablebooleanДа—
identitystringДа—
codestringДа—
detailstringДа—
suitabilitystring<ready, needs_setup, unknown, unsuitable, blocked>Да—

Грешке које ова крајња тачка може вратити

401 · 403 · 404