hosting
POST /v1/site-blueprints/{siteBlueprintId}/screenshot
Mint a time-limited URL for a blueprint's screenshot.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/site-blueprints/{siteBlueprintId}/screenshot \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Returns a presigned URL the browser fetches directly from object storage. ⛔ **`POST`, despite reading nothing** — the same rule `downloadSiteBackup` follows: the response body is a signed credential for customer content (a picture of their site, which can show unlaunched branding or a page behind a login), so a `GET` would invite it into browser history, proxy logs and shared caches. The grant expires in ten minutes; take a new one rather than storing it. A blueprint with no screenshot is a `422`, not a `404` — the blueprint exists, the picture does not. Requires `sites.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteBlueprintId (path) | Uuid | はい | A SITE blueprint's id (UUIDv7) — one of the customer's own captured sites. ⛔ Not a `blueprintId`: that names a published stack recipe, and the two are different resources that u… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
url | string | はい | ⛔ A **bearer credential** for the picture until it expires — never log it, never store it, hand it straight to the browser. |
expires_at | string | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429