メインコンテンツへスキップ

TypeScript SDK クイックスタート

公式の @qumo-deploy/sdk パッケージを使うと、Qumo Deploy のコントロールプレーンを、強く型付けされたコードから余すところなく操作できます。

インストール

SDK は JSR で公開されています。どのパッケージマネージャーも JSR からインストールし、インポート名はいずれの場合も @qumo-deploy/sdk です。

クライアントの初期化

ベース URL とクレデンシャルを渡して QumoClient のインスタンスを作成します。

認証モード

クライアントは 2 種類の認証方式に対応しています。
  1. Bearer トークン(token): スクリプトや CI/CD 向けです。パーソナルアクセストークン(qumo_pat_...)またはアイデンティティトークンを渡します。Authorization: Bearer <token> を送信します。
  2. セッション Cookie + CSRF(csrfToken): コンソールと同じオリジンで動き、セッション Cookie があるブラウザのコード向けです。api.qumo-deploy.com は Cookie を無視するため、baseUrl には空文字列(同一オリジン)を指定します。qumo_csrf_token Cookie の値を返すコールバックを渡すと、クライアントは変更系リクエストでそれを X-CSRF-Token として送信します。

最初の API 呼び出し: 組織とプロジェクトの取得

このサンプルにはパーソナルアクセストークンが必要です。アイデンティティトークンはユーザーではなくプロジェクトに属するため、 所属組織の一覧取得は 401 で拒否されます。