Esta página documenta
@squarecloud/api v5. Si estás actualizando desde la v4, lee primero la guía de migración v4 → v5. Si vienes de la v3, consulta la guía de migración v3 → v4.Requisitos
- Node.js 20.0.0 o más reciente
- Una clave de API válida — solicita una en el Panel de Square Cloud
Instalación
- npm
- yarn
- pnpm
Instanciar el cliente
- TypeScript
- JavaScript (ESM)
- JavaScript (CommonJS)
Constructor
Módulos
El cliente expone toda la plataforma v2 a través de módulos dedicados. Cada módulo es una propiedad de la instancia deSquareCloudAPI.
Obtener el usuario autenticado
api.user.get() devuelve una instancia de User que contiene los detalles de la cuenta, el plan actual, las aplicaciones propias y las bases de datos propias.
user.applications y user.databases son instancias de Collection (una subclase de Map). Itéralas como cualquier Map:
Obtener una sola aplicación
Usaapi.applications.fetch(id) para recuperar una Application completamente poblada (o WebsiteApplication, cuando la app tiene un dominio de sitio web).
api.applications.get(id) todavía existe, pero devuelve la BaseApplication más ligera y solo se conserva por compatibilidad con versiones anteriores. Prefiere .fetch() para v5.
Listar el historial de snapshots (a nivel de cuenta)
Estado de la plataforma
api.service.status() expone el estado de salud agregado de la plataforma (los mismos datos que se muestran en la página de estado pública).
A diferencia de la mayoría de los endpoints v2, esta ruta no envuelve su payload en el sobre estándar
{ status, response }.Caché del cliente
El cliente mantiene una caché en memoria que el SDK mantiene sincronizada a medida que realizas llamadas:Manejo de errores
Las solicitudes fallidas lanzan unSquareCloudAPIError. El error expone una propiedad code estable sobre la que puedes hacer un switch para distinguir los modos de fallo.
Códigos de error (APIErrorCode)
APIErrorCode es una const/union exportada por el SDK (reexportada desde @squarecloud/api-types) que enumera todos los valores que puede tomar err.code. La v5 renombró varios códigos por consistencia; los nombres antiguos se mantienen como alias de tipo obsoletos, pero el SDK ahora solo lanza los nombres nuevos.
Códigos sin cambios:
KEEP_CALM (429 breve, reintentar en segundos), ACCESS_DENIED (401), PAYLOAD_TOO_LARGE (413), RATE_LIMIT_EXCEEDED.
Nuevos en v5:

