Orbit の API
コードから操作できるアプリビルダー API
アプリは HTTP リソースです。POST で作成し、PATCH で変更し、deploy の呼び出しで公開します。Studio が行うことも、すべて同じモデルの上で動きます。
トークンは組織単位。意図しない共有は起きません。
アプリビルダー API でできること
ほかのすべての入り口と同じアプリモデルを、素の REST で扱います。
POST /api/v1/apps
アプリを作成します。レスポンスにリソースとその id が入ります。
PATCH /api/v1/apps/{id}
変更可能なフィールドを更新します。
GET /api/v1/apps
トークンから見えるものを一覧します。
POST /api/v1/apps/{id}/deployments
アプリを公開します。Studio が実行するものと同じ deploy です。
API も同じアプリモデル
Studio も CLI も API も、同じアプリを読み書きします。あなたのコードが動かすのは別系統の仕組みではなく、同じハンドルを握るもう一つの手です。
よくある質問
認証はどうしますか。
組織単位のトークンを使います。リクエストはその組織の中だけで動作します。
API は現在どこまで作れますか。
アプリとデプロイメントです。Studio と同じライフサイクル、つまり作成、変更、デプロイ、確認を扱えます。
仕様書はありますか。
最新の内容はドキュメントにあります。docs.orbitapps.io の API セクションから始めてください。
API の利用に料金はかかりますか。
いいえ。どの入り口からでも、作ること自体は無料です。料金がかかるのは AI の利用と、2 つ目以降のデプロイの 2 つだけです。
