hosting
POST /v1/media-offload/claim
The WordPress plugin, redeeming a pairing code for a scoped token.
認証
このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/media-offload/claim \
-H "Content-Type: application/json" \
-d '{ "code": <string> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Called by the Zinn® Media Offload plugin on a customer's WordPress server. **This endpoint is unauthenticated**: the caller has no session with us and can name no organisation — the pairing code is what names it. Every failure — an expired code, an already-claimed code and a code that never existed — returns the same `422`. Distinguishing them would confirm to a caller that a guessed code exists, which is the only thing between them and another organisation's storage.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
code | string | はい | — |
plugin_version | string | いいえ | — |
site_url | string | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
token | string | はい | Shown once and never again. Stored by us only as a SHA-256 hash. |
site_id | string | はい | — |
prefix | string | はい | The key prefix this site's objects live under. |
public_base_url | string | いいえ | Where a rewritten media URL points. Empty when the bucket is private, in which case the plugin must not rewrite anything. |
rewrite_urls | boolean | はい | — |
delete_local | boolean | はい | — |
このエンドポイントが返すエラー
422 · 429