hosting

POST `/v1/media-offload/claim`

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

Authentifizierung

Dieser Endpunkt ist öffentlich. Er erfordert weder Anmeldedaten noch eine Organisation – er wird auch von unserer eigenen Marketing-Website und den KI-Antwort-Engines gelesen.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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.

Anfragekörper

Name	Typ	Erforderlich	Was es ist
`code`	`string`	Ja	—
`plugin_version`	`string`	Nein	—
`site_url`	`string`	Nein	—

Antwort

Name	Typ	Erforderlich	Was es ist
`token`	`string`	Ja	Shown once and never again. Stored by us only as a SHA-256 hash.
`site_id`	`string`	Ja	—
`prefix`	`string`	Ja	The key prefix this site's objects live under.
`public_base_url`	`string`	Nein	Where a rewritten media URL points. Empty when the bucket is private, in which case the plugin must not rewrite anything.
`rewrite_urls`	`boolean`	Ja	—
`delete_local`	`boolean`	Ja	—

Fehler, die dieser Endpunkt zurückgeben kann

422 · 429

POST /v1/media-offload/claim