multipart/form-data entgegen, und Echtzeit streamt Server-Sent Events.
Basis-URL
Jeder Endpoint dieser Referenz ist relativ zu:https://blob.squarecloud.app/v1, und nimmt denselben API-Schlüssel an.
Authentifizierung
Erstelle einen API-Schlüssel in deinen Sicherheitseinstellungen des Kontos und sende ihn im HeaderAuthorization jeder Anfrage. Das Präfix Bearer ist optional.
Deine erste Anfrage
Kontoinformationen liefert dein Profil, deinen Plan und jede Anwendung und Datenbank, die dir gehört. Dafür brauchst du einen Schlüssel mit dem Scopeaccount:read.
401 ACCESS_DENIED, fehlt der Schlüssel oder wird nicht erkannt. Bekommst du 403 MISSING_SCOPE, funktioniert der Schlüssel, aber ihm fehlt account:read.
Antwortformat
Ein erfolgreicher Aufruf antwortet mit2xx und "status": "success" und, wenn es etwas zurückzugeben gibt, mit den Daten in response:
{ "status": "success" }. Ein fehlgeschlagener Aufruf antwortet mit 4xx oder 5xx, "status": "error" und einem code, nach dem du verzweigen kannst:
snake_case. Jeder Code steht mit der passenden Lösung unter Fehler.
IDs
- Anwendungen und Datenbanken haben eine 32-stellige hexadezimale ID, etwa
a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d. Du findest sie über Kontoinformationen oder in der Adresse der Ressource im Dashboard. - Eine über einen Workspace mit dir geteilte Anwendung wird im Pfad als
<appId>-<workspaceId>angesprochen, zum Beispiel/v2/apps/<appId>-<workspaceId>/status. - Workspaces haben eine 32-stellige hexadezimale ID. Ältere Workspaces behalten eine 40-stellige.
Limits
Jedes Konto hat ein Budget an Anfragen pro 60 Sekunden, das sein Plan festlegt, und manche Endpoints haben ein eigenes Limit, das auf ihrer Seite steht. Die Werte findest du unter Limits und Einschränkungen, wie429 funktioniert, unter Fehler.
OpenAPI-Spezifikation
Die gesamte API ist in einem OpenAPI-Dokument unterhttps://api.squarecloud.app/v2/openapi.json beschrieben. Importiere es in Postman oder Insomnia oder generiere daraus einen Client.
Nächste Schritte
Authentifizierung und Scopes
Wähle die Scopes, die jede Integration braucht.
Fehlercodes
Jeder Code, den die API liefert, und wie du damit umgehst.
Eine Anwendung hochladen
Ein Zip mit einer einzigen Anfrage deployen.
Rate Limits
Anfragebudgets pro Plan.

