hosting

POST `/v1/media-offload/claim`

The WordPress plugin, redeeming a pairing code for a scoped token.

Аутентификация

Этот эндпоинт является публичным. Он не требует учетных данных и организации — его читают наш собственный маркетинговый сайт и поисковые системы на базе ИИ.

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

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X POST https://api.zinndigital.com/v1/media-offload/claim \
  -H "Content-Type: application/json" \
  -d '{ "code": <string> }'

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему 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