hosting

POST /v1/sites/{siteId}/hosting/applications

Install a one-click application onto a live site.

Всички крайни точки в hosting

Всички документи за разработчици

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/hosting/applications \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "application": <string> }'

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

Installs application onto the site's hosting package. The submit is instant and the work runs as a durable workflow (§2.16), so this answers 202 with the install row — poll GET on this path and read current for its state. ⛔ This is destructive: a one-click install unpacks a whole application over the site's document root and creates a database, so it is gated on hosting.applications.manage rather than on hosting.deploy.manage, and only one install may run per site at a time (409 otherwise). 404 for a site whose platform has no application catalogue at all — a site on our own fleet simply does not have this resource, and naming the platform it is not on would disclose which vendor a site runs on. 422 when the catalogue exists but that application is not offered: either the product line does not sell it, or the vendor no longer carries it. The application list is per product line — the footprint-free line deliberately offers a narrower set than mainstream — and it is read live, so a page left open can offer something that has since gone.

Параметри

ИмеТипЗадължителноКакво представлява
siteId (path)UuidДаSite ID (UUIDv7).

Тяло на заявката

ИмеТипЗадължителноКакво представлява
applicationstringДаThe key of an application from this site's own list. Validated against the live catalogue rather than a fixed enum, because the range changes without a release on our side.
localestringНеThe language to install the site in, as a platform language code (de, pt-BR). Applies to wordpress only, and is saved to the site so a later reinstall keeps it. Omit to use…

Отговор

ИмеТипЗадължителноКакво представлява
idstringДа
application_keystringДа
application_namestringДаThe display name captured at the moment of installing — a snapshot, so history still reads correctly after the platform renames or retires an application.
statusstring<queued, installing, installed, failed>Да
messagestringДаCustomer-facing English. Only meaningful when failed.
requested_bystringНеThe actor who asked for it, for the audit trail.
started_atstringНе
finished_atstringНе
created_atstringДа

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 409 · 422 · 429 · 503