Skip to main content
POST
Rufen Sie signierte PUT-URLs für einen Referenzbildupload Ihres Kontos ab. Ein Bild mit 8 MiB hat höchstens zwei Teile. Speichern Sie den von jeder PUT-Anfrage zurückgegebenen ETag für upload_complete.

Authentifizierung und Berechtigungen

string
erforderlich
Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt. OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.
Erforderliche Berechtigungen: thumbnails:write. Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.

Parameter

string
An der Transportschnittstelle optional: Bei fehlender Angabe fügt der Server vor der Validierung eine Kennung ein. Geben Sie eine eigene stabile UUID v4 an, um eine verlorene Antwort sicher wiederherstellen zu können.Format: “uuid”. Muster: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
string
erforderlich
Die von der upload_initialize-Aktion dieser Domäne zurückgegebene uploadId.Format: “uuid”. Muster: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.
array
erforderlich
Liste von Werten. Die Struktur der Elemente finden Sie im vollständigen Eingabeschema.Mindestanzahl an Elementen: 1. Höchstanzahl an Elementen: 2.
Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.

Idempotenz

Verwenden Sie für jede Mutation eine UUID v4 in requestId oder im HTTP-Header Idempotency-Key. Verwenden Sie nach einem Netzwerkfehler dieselbe Kennung und identische Argumente erneut. Wenn Sie beides angeben, müssen die Werte übereinstimmen. Die Wiederholung einer gespeicherten Anfrage führt die Operation nicht erneut aus und verbraucht keinen weiteren monatlichen Aufruf. Fehlgeschlagene oder unterbrochene Anfragen werden nicht automatisch neu gestartet. Jede Mutation kann HTTP 202 zurückgeben, wenn bei einem Wiederholungsversuch dieselbe Anfrage noch läuft, auch wenn ihre erste Ausführung normalerweise synchron erfolgt. Wenn die Ausführung abgeschlossen ist, resultStored aber false ist, gibt ein Wiederholungsversuch HTTP 200 mit dem gespeicherten Anfragestatus anstelle des ursprünglichen Ergebnisses zurück. Rufen Sie die Ausgabe über die für ihren Bereich vorgesehene Verlaufs-, Ergebnis- oder Downloadaktion ab.

Anfragebeispiele

Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.

Antwort

Eine erfolgreiche erste Ausführung gibt HTTP 200 mit dem Ergebnis der Operation unter data zurück. Bei einer Wiederholung kann stattdessen der gespeicherte Anfragestatus zurückgegeben werden. Das Beispiel zeigt eine unterstützte Antwort, nicht alle optionalen Felder. Ein Array temporärer signierter PUT-URLs, eine pro unterschiedlicher angefragter Teilnummer. Die Antwort enthält keine Bildbytes, ETags oder Größenfelder pro Teil.

Ergebnisfelder

Diese Anfrage wiederherstellen und abfragen

Verwenden Sie auch nach einem Verbindungsabbruch dieselbe Kennung. Wenn resultStored den Wert false hat, rufen Sie die Ausgabe über die entsprechende Verlaufs-, Ergebnis- oder Downloadaktion ab. Starten Sie niemals eine zweite Generierung, nur um den Fortschritt zu prüfen.
HTTP 200

Hinweise zur Operation

  • Erfordert thumbnails:write; es ist kein zusätzlicher Upload-Scope erforderlich.
  • uploadId ist die UUID aus initialize. partNumbers enthält 1–2 Ganzzahlen, jeweils zwischen 1 und 2, und jeder Teil muss für die deklarierte fileSize dieser Sitzung existieren. Doppelte angeforderte Teilnummern werden zu einer URL zusammengefasst.
  • Übertragen Sie die rohen binären Bytes jedes Teils per PUT an die jeweilige zurückgegebene URL. Content-Length ist signiert und muss exakt min(partSize, fileSize - (partNumber - 1) × partSize) entsprechen. Im Beispiel mit 7 MiB umfasst Teil 1 genau 5,242,880 Bytes und Teil 2 genau 2,097,152 Bytes. Senden Sie weder JSON noch multipart/form-data oder base64 an die signierte URL.
  • Speichern Sie den ETag-Antwortheader jedes erfolgreichen PUT und senden Sie diese Werte an thumbnails_upload_complete. Behandeln Sie signierte URLs als private, temporäre Upload-Berechtigungen.
  • Nur ein Upload des verbundenen Benutzers kann signiert, abgeschlossen oder abgebrochen werden. Diese Aliase akzeptieren nur JPG-, PNG- und WebP-Sitzungen mit höchstens 8 MiB, auch wenn die Sitzung über eine andere Uploadfamilie erstellt wurde.
  • Die Upload-Sitzung in der Produktionsumgebung läuft nach 24 Stunden ab. Signierte Teil-URLs laufen nach einer Stunde ab. Abschluss und Abbruch entfernen die aktive Sitzung; sign-parts und complete geben dann Upload not found zurück. Keine der beiden Antworten enthält ein expiresAt-Feld.
  • Verwenden Sie eine UUID v4 als requestId oder den HTTP-Header Idempotency-Key und verwenden Sie denselben Wert bei Wiederholungsversuchen mit identischen Eingaben erneut. Die Integrationsebene zeichnet jede Änderung auf und gibt ihren aufgezeichneten Status oder ihr Ergebnis zurück, ohne sie erneut auszuführen. Eine fehlgeschlagene oder unterbrochene Anfrage wird nicht automatisch wiederholt.
  • Um nach Ablauf ihrer Gültigkeit von einer Stunde neue URLs zu erhalten, während die Sitzung noch aktiv ist, rufen Sie sign-parts mit einer neuen requestId auf. Ein erneuter Versuch mit derselben requestId gibt ihr gespeichertes Ergebnis einschließlich der alten URLs zurück.

Nutzung

Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.

Fehler