JavaScript、Python、Go の公式 SDK

SDK を選ぶ

すべての SDK はオープンソースで、GitHub で公開されています。ランタイム依存関係はゼロで、API のデータをフィールド名も含めてそのまま返します。

JavaScript

@squarecloud/api v6。アプリ、データベース、workspace、deploy、ネットワーク、リアルタイム、snapshot、AI を、Node.js、Deno、Bun、エッジランタイムで扱えます。

Python

squarecloud-api v5。同じ範囲をカバーし、同期クライアントと非同期クライアントを備え、標準ライブラリのみを使用します。

Go

sdk-api-go v3。同じ範囲をカバーし、すべての呼び出しで context を受け取り、エラー型は 1 つだけです。

Blob Storage (JavaScript)

@squarecloud/blob v4。最大 10 GiB のアップロード、プライベートオブジェクト、リンク、共有、ルール、S3 ゲートウェイを、Node.js とブラウザで扱えます。

概要

SDK	パッケージ	バージョン	ランタイム	インストール
JavaScript	`@squarecloud/api`	6.0.0	Node.js 22+、Deno、Bun、エッジ	`npm install @squarecloud/api`
Python	`squarecloud-api` (インポート名は `squarecloud`)	5.0.0	Python 3.11+	`pip install squarecloud-api`
Go	`github.com/squarecloudofc/sdk-api-go/v3`	3.0.0	Go 1.22+	`go get github.com/squarecloudofc/sdk-api-go/v3`
Blob Storage	`@squarecloud/blob`	4.0.0	Node.js 20+ とブラウザ	`npm install @squarecloud/blob`

クイックスタート

数分で最初の呼び出しを行えます。以下のプログラムはどれも、アカウント名と API キーから見えるアプリの数を出力します。

API キーを作成する

アカウントのセキュリティ設定でキーを作成します。キーはパスワードと同じように扱い、ソースコードには含めないでください。

環境変数 SQUARECLOUD_API_KEY を設定する

サンプルは SQUARECLOUD_API_KEY からキーを読み取ります。サンプルを実行するターミナルで設定してください:

macOS / Linux
Windows (PowerShell)

export SQUARECLOUD_API_KEY="your-api-key"

$env:SQUARECLOUD_API_KEY = "your-api-key"

SDK をインストールして最初の呼び出しを行う

JavaScript
Python
Go

npm install @squarecloud/api

index.mjs

import { SquareCloudAPI } from "@squarecloud/api";

const api = new SquareCloudAPI(process.env.SQUARECLOUD_API_KEY);
const { user, applications } = await api.account.me();

console.log(`Hi ${user.name}, you have ${applications.length} apps`);

node index.mjs

pip install squarecloud-api

main.py

import os

from squarecloud import SquareCloud

with SquareCloud(os.environ["SQUARECLOUD_API_KEY"]) as client:
    me = client.account.me()
    print(f"Hi {me['user']['name']}, you have {len(me['applications'])} apps")

python main.py

go mod init example.com/hello
go get github.com/squarecloudofc/sdk-api-go/v3

main.go

package main

import (
	"context"
	"fmt"
	"log"
	"os"

	"github.com/squarecloudofc/sdk-api-go/v3"
)

func main() {
	c := squarecloud.New(os.Getenv("SQUARECLOUD_API_KEY"))

	me, err := c.Account.Me(context.Background())
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Hi %s, you have %d apps\n", me.User.Name, len(me.Applications))
}

go run .

出力を確認する

プログラムは、アカウント名とキーから見えるアプリの数を出力します:

Hi Jane, you have 3 apps

401 ACCESS_DENIED エラーは、キーが間違っている、取り消されている、または期限切れであることを意味します。環境変数が設定されていない場合、プログラムは何も送信せずに停止します。

各 SDK がカバーする範囲

JavaScript、Python、Go の SDK は Square Cloud API 全体をカバーします。同じ 67 個の操作に加え、snapshot ファイルのダウンロードにも対応しています。ページ構成、サンプル、動作はすべて共通です:

HTTP ステータスと API のエラーコードを持つ、単一のエラークラス
30 秒のタイムアウト。サーバーが接続を保持する呼び出しでは最低 120 秒
安全に繰り返せる失敗に対してのみリトライし、429 では決してリトライしない
workspace を通じて共有されたアプリを操作するための <appId>-<workspaceId> 形式の ID

Blob Storage SDK は Blob API と S3 ゲートウェイをカバーします。独自のクライアント、認証情報、エラーコードを持つ別パッケージです。

エラーリファレンス

エラーに関する各 SDK のページでは、エラークラス、リトライ、レート制限を説明しています。エラーコード自体は API から返されます。すべてのコードは API エラーリファレンスに、Blob Storage のコードは Blob API エラーリファレンスに掲載しています。

SDK	エラー、リトライ、レート制限
JavaScript	`SquareCloudAPIError`
Python	`SquareCloudAPIError`
Go	`*APIError`
Blob Storage	`SquareCloudBlobError`

アップグレード

上記の API SDK のリリースはいずれも全面的な書き直しです。移行ガイドを参照してください: JavaScript v5 → v6、Python v4 → v5、Go v2 → v3、Blob v3 → v4。 Square Cloud は SDK の改善と新しい言語への対応を続けています。お使いの言語が見当たらない場合は、お知らせください。

次のステップ

API 入門

curl で REST API を直接呼び出します。

CLI クイックスタート

ターミナルからアプリを deploy して管理します。

Blob API クイックスタート

curl で Blob Storage にファイルをアップロードします。

CLI

VS Code

SDKs

JavaScript、Python、Go の公式 SDK

SDK を選ぶ

JavaScript

Python

Go

Blob Storage (JavaScript)

概要

クイックスタート

各 SDK がカバーする範囲

エラーリファレンス

アップグレード

次のステップ

API 入門

CLI クイックスタート

Blob API クイックスタート

​SDK を選ぶ

JavaScript

Python

Go

Blob Storage (JavaScript)

​概要

​クイックスタート

​各 SDK がカバーする範囲

​エラーリファレンス

​アップグレード

​次のステップ

API 入門

CLI クイックスタート

Blob API クイックスタート

SDK を選ぶ

概要

クイックスタート

各 SDK がカバーする範囲

エラーリファレンス

アップグレード

次のステップ