このページは
@squarecloud/api v5 を解説しています。v4 からのアップグレードの場合は、まず v4 → v5 移行ガイド をお読みください。v3 からの場合は v3 → v4 移行ガイド を参照してください。要件
- Node.js 20.0.0 以降
- 有効な API キー — Square Cloud ダッシュボード でリクエストできます
インストール
- npm
- yarn
- pnpm
クライアントの初期化
- TypeScript
- JavaScript (ESM)
- JavaScript (CommonJS)
コンストラクタ
モジュール
クライアントは v2 プラットフォーム全体を専用のモジュールを通して公開します。各モジュールはSquareCloudAPI インスタンスのプロパティです。
認証済みユーザーの取得
api.user.get() は、アカウント詳細、現在のプラン、所有するアプリケーション、所有するデータベースを含む User インスタンスを返します。
user.applications と user.databases は Collection インスタンス(Map のサブクラス)です。通常の Map と同じように反復処理できます:
単一のアプリケーションの取得
api.applications.fetch(id) を使うと、完全に読み込まれた Application(アプリにウェブサイトドメインがある場合は WebsiteApplication)を取得できます。
api.applications.get(id) オーバーロードも依然として存在しますが、これはより軽量な BaseApplication を返し、後方互換性のためだけに残されています。v5 では .fetch() を優先してください。
snapshot 履歴の一覧取得(アカウント全体)
プラットフォームステータス
api.service.status() は、集約されたプラットフォームの健全性(公開ステータスページに表示されるものと同じデータ)を公開します。
ほとんどの v2 エンドポイントとは異なり、このルートはペイロードを標準の
{ status, response } エンベロープで ラップしません。クライアントキャッシュ
クライアントは、呼び出しを行うたびに SDK が同期を保つインメモリキャッシュを維持します:エラーハンドリング
失敗したリクエストはSquareCloudAPIError をスローします。このエラーは、失敗モードを判別するために switch できる安定した code プロパティを公開します。
エラーコード(APIErrorCode)
APIErrorCode は SDK がエクスポートする const/union 型(@squarecloud/api-types から再エクスポート)で、err.code が取りうるすべての値を列挙しています。v5 では一貫性のために複数のコードがリネームされました。旧名は非推奨の型エイリアスとして残っていますが、SDK が実際にスローするのは新名のみです。
変更のないコード:
KEEP_CALM(短時間の 429、秒単位でリトライ)、ACCESS_DENIED(401)、PAYLOAD_TOO_LARGE(413)、RATE_LIMIT_EXCEEDED。
v5 の新規コード:

