Diese Seite dokumentiert
@squarecloud/api v5. Wenn Sie von v4 aktualisieren, lesen Sie zuerst den Migrationsleitfaden v4 → v5. Wenn Sie von v3 kommen, siehe den Migrationsleitfaden v3 → v4.Voraussetzungen
- Node.js 20.0.0 oder neuer
- Ein gültiger API-Schlüssel — fordern Sie einen im Square Cloud Dashboard an
Installation
- npm
- yarn
- pnpm
Instanziierung des Clients
- TypeScript
- JavaScript (ESM)
- JavaScript (CommonJS)
Konstruktor
Module
Der Client stellt die gesamte v2-Plattform über dedizierte Module bereit. Jedes Modul ist eine Eigenschaft derSquareCloudAPI-Instanz.
Den authentifizierten Benutzer abrufen
api.user.get() gibt eine User-Instanz zurück, die die Kontodetails, den aktuellen Plan, die eigenen Anwendungen und die eigenen Datenbanken enthält.
user.applications und user.databases sind Collection-Instanzen (eine Map-Unterklasse). Iterieren Sie darüber wie über jede Map:
Eine einzelne Anwendung abrufen
Verwenden Sieapi.applications.fetch(id), um eine vollständig befüllte Application (oder WebsiteApplication, wenn die App eine Website-Domain hat) abzurufen.
api.applications.get(id) existiert weiterhin, gibt aber die leichtgewichtigere BaseApplication zurück und wird nur aus Gründen der Abwärtskompatibilität beibehalten. Bevorzugen Sie .fetch() für v5.
Snapshot-Verlauf auflisten (kontoweit)
Plattformstatus
api.service.status() stellt den aggregierten Plattformzustand bereit (dieselben Daten, die auf der öffentlichen Statusseite angezeigt werden).
Anders als die meisten v2-Endpoints kapselt diese Route ihr Payload nicht in den Standard-Envelope
{ status, response }.Client-Cache
Der Client unterhält einen In-Memory-Cache, den das SDK synchron hält, während Sie Aufrufe tätigen:Fehlerbehandlung
Fehlgeschlagene Anfragen werfen einenSquareCloudAPIError. Der Fehler stellt eine stabile code-Eigenschaft bereit, auf die Sie verzweigen können, um Fehlermodi zu unterscheiden.
Fehlercodes (APIErrorCode)
APIErrorCode ist eine const/Union, die vom SDK exportiert wird (re-exportiert aus @squarecloud/api-types) und jeden Wert auflistet, den err.code annehmen kann. v5 hat mehrere Codes aus Konsistenzgründen umbenannt; die alten Namen bleiben als veraltete Typ-Aliase erhalten, aber das SDK wirft nur noch die neuen Namen.
Unveränderte Codes:
KEEP_CALM (kurzer 429, erneut versuchen nach Sekunden), ACCESS_DENIED (401), PAYLOAD_TOO_LARGE (413), RATE_LIMIT_EXCEEDED.
Neu in v5:

