hosting
POST /v1/sites/{siteId}/hosting/applications
Install a one-click application onto a live site.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
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 زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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). |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
application | string | بله | 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. |
locale | string | خیر | 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… |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
id | string | بله | — |
application_key | string | بله | — |
application_name | string | بله | The display name captured at the moment of installing — a snapshot, so history still reads correctly after the platform renames or retires an application. |
status | string<queued, installing, installed, failed> | بله | — |
message | string | بله | Customer-facing English. Only meaningful when failed. |
requested_by | string | خیر | The actor who asked for it, for the audit trail. |
started_at | string | خیر | — |
finished_at | string | خیر | — |
created_at | string | بله | — |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 409 · 422 · 429 · 503