Cette page documente
@squarecloud/api v5. Si vous effectuez une mise à niveau depuis la v4, lisez d’abord le guide de migration v4 → v5. Si vous venez de la v3, consultez le guide de migration v3 → v4.Prérequis
- Node.js 20.0.0 ou une version plus récente
- Une clé d’API valide — demandez-en une sur le tableau de bord Square Cloud
Installation
- npm
- yarn
- pnpm
Instanciation du client
- TypeScript
- JavaScript (ESM)
- JavaScript (CommonJS)
Constructeur
Modules
Le client expose l’intégralité de la plateforme v2 via des modules dédiés. Chaque module est une propriété de l’instanceSquareCloudAPI.
Récupérer l’utilisateur authentifié
api.user.get() renvoie une instance User contenant les détails du compte, le plan actuel, les applications possédées et les bases de données possédées.
user.applications et user.databases sont des instances Collection (une sous-classe de Map). Parcourez-les comme n’importe quelle Map :
Récupérer une application unique
Utilisezapi.applications.fetch(id) pour récupérer une Application entièrement renseignée (ou une WebsiteApplication, lorsque l’application possède un domaine de site web).
api.applications.get(id) existe toujours, mais elle renvoie la BaseApplication plus légère et n’est conservée que pour la rétrocompatibilité. Préférez .fetch() pour la v5.
Lister l’historique des snapshots (à l’échelle du compte)
État de la plateforme
api.service.status() expose l’état de santé agrégé de la plateforme (les mêmes données affichées sur la page de statut publique).
Contrairement à la plupart des endpoints v2, cette route n’enveloppe pas sa charge utile dans l’enveloppe standard
{ status, response }.Cache du client
Le client maintient un cache en mémoire que le SDK garde synchronisé au fil de vos appels :Gestion des erreurs
Les requêtes en échec lèvent uneSquareCloudAPIError. L’erreur expose une propriété code stable sur laquelle vous pouvez brancher un switch pour distinguer les modes de défaillance.
Codes d’erreur (APIErrorCode)
APIErrorCode est une const/union exportée par le SDK (ré-exportée depuis @squarecloud/api-types) qui liste toutes les valeurs que peut prendre err.code. La v5 a renommé plusieurs codes pour plus de cohérence ; les anciens noms sont conservés en tant qu’alias de type dépréciés, mais le SDK ne lève désormais que les nouveaux noms.
Codes inchangés :
KEEP_CALM (429 court, réessayez après quelques secondes), ACCESS_DENIED (401), PAYLOAD_TOO_LARGE (413), RATE_LIMIT_EXCEEDED.
Nouveautés de la v5 :

