SDKs officiels pour JavaScript, Python et Go

Choisissez votre SDK

Tous les SDKs sont open source et disponibles sur GitHub. Ils n’ont aucune dépendance d’exécution et renvoient les données de l’API telles quelles, noms de champs compris.

JavaScript

@squarecloud/api v6. Applications, bases de données, workspaces, deploys, réseau, temps réel, snapshots et IA, sur Node.js, Deno, Bun et les runtimes edge.

Python

squarecloud-api v5. La même couverture, avec un client synchrone et un client asynchrone, en n’utilisant que la bibliothèque standard.

Go

sdk-api-go v3. La même couverture, avec context sur chaque appel et un seul type d’erreur.

Blob Storage (JavaScript)

@squarecloud/blob v4. Envois jusqu’à 10 GiB, objets privés, liens, partages, règles et passerelle S3, sur Node.js et dans le navigateur.

En un coup d’œil

SDK	Paquet	Version	Environnement d’exécution	Installation
JavaScript	`@squarecloud/api`	6.0.0	Node.js 22+, Deno, Bun, edge	`npm install @squarecloud/api`
Python	`squarecloud-api` (import `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+ et navigateurs	`npm install @squarecloud/blob`

Démarrage rapide

Faites votre premier appel en quelques minutes. Chaque programme ci-dessous affiche le nom de votre compte et le nombre d’applications que votre clé API peut voir.

Créer une clé API

Créez une clé dans les paramètres de sécurité de votre compte. Traitez-la comme un mot de passe : gardez-la hors de votre code source.

Définir la variable d'environnement SQUARECLOUD_API_KEY

Les exemples lisent la clé depuis SQUARECLOUD_API_KEY. Définissez-la dans le terminal où vous les exécutez :

macOS / Linux
Windows (PowerShell)

export SQUARECLOUD_API_KEY="your-api-key"

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

Installer le SDK et faire votre premier appel

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 .

Vérifier le résultat

Le programme affiche le nom de votre compte et le nombre d’applications que la clé peut voir :

Hi Jane, you have 3 apps

Une erreur 401 ACCESS_DENIED signifie que la clé est incorrecte, révoquée ou expirée. Si la variable n’est pas définie, le programme s’arrête avant d’envoyer quoi que ce soit.

Ce que couvre chaque SDK

Les SDKs JavaScript, Python et Go couvrent l’intégralité de l’API Square Cloud : les mêmes 67 opérations, plus le téléchargement des fichiers de snapshot. Ils partagent la même structure de pages, les mêmes exemples et le même comportement :

une seule classe d’erreur, avec le statut HTTP et le code d’erreur de l’API ;
un timeout de 30 secondes, et d’au moins 120 secondes pour les appels que le serveur maintient ouverts ;
des nouvelles tentatives uniquement pour les échecs qui peuvent être répétés sans risque, jamais pour un 429 ;
des identifiants <appId>-<workspaceId> pour agir sur les applications partagées via un workspace.

Le SDK Blob Storage couvre l’API Blob et la passerelle S3. C’est un paquet distinct, avec son propre client, ses propres identifiants et ses propres codes d’erreur.

Références des erreurs

Chaque page d’erreurs d’un SDK couvre sa classe d’erreur, ses nouvelles tentatives et ses limites de débit. Les codes d’erreur eux-mêmes viennent de l’API : la référence des erreurs de l’API les liste tous, et la référence des erreurs de l’API Blob liste les codes de Blob Storage.

SDK	Erreurs, nouvelles tentatives et limites de débit
JavaScript	`SquareCloudAPIError`
Python	`SquareCloudAPIError`
Go	`*APIError`
Blob Storage	`SquareCloudBlobError`

Mise à niveau

Chacune des versions des SDKs d’API ci-dessus est une réécriture. Consultez les guides de migration : JavaScript v5 → v6, Python v4 → v5, Go v2 → v3 et Blob v3 → v4. Square Cloud continue d’améliorer ses SDKs et d’ajouter de nouveaux langages. Si le vôtre manque, faites-le-nous savoir.

Prochaines étapes

Introduction à l'API

Appelez directement l’API REST, avec curl.

Démarrage rapide de la CLI

Déployez et gérez vos applications depuis le terminal.

Démarrage rapide de l'API Blob

Envoyez un fichier vers Blob Storage avec curl.

​Choisissez votre SDK

JavaScript

Python

Go

Blob Storage (JavaScript)

​En un coup d’œil

​Démarrage rapide

​Ce que couvre chaque SDK

​Références des erreurs

​Mise à niveau

​Prochaines étapes