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

POST /v1/media-offload/claim