A API JSON Capgoの公開JSONインターフェイスは、HTTP要求と応答を通じてソフトウェア間で構造化されたデータを交換することを可能にします。Capgoの型付きRESTfulAPIは、CapacitorJSとElectronチームに、ライブアップデート、チャンネル、バンドル、デバイス配信をプログラムで制御する機能を提供します。
目次
Understanding Capgo Public API JSON Fundamentals
Capgoは一般的なデータディレクトリではありません。Capgoの公開APIJSONインターフェイスは、ビルドシステムとCapgoのクラウド配信サービスを接続することで、リリース自動化が署名されたWebバンドルをApp StoreまたはPlayレビューの待たずに公開および指示できるようにします。RESTは、GET、POST、PUT、PATCH、DELETEなどの一般的なHTTPメソッドを使用し、JSONはこの HTTP要求メソッド、JSONはよく使われる応答形式です。 REST API guide from Postman.
Capgoの場合、JSONは自動化スクリプト、CI/CDジョブ、TypeScriptクライアント、および配信プラットフォームの間で共通言語です。 その一貫性により、ログで読みやすく、デプロイメントが開始される前に検証しやすいパイロットが得られます。
What the Interface Controls
CapgoのパブリックAPI JSONエンドポイントを使用して、運用リリースのリソースを管理します。
- BundlesCapgoの公開__CAPGO_KEEP_0__ JSONエンドポイントを使用して、運用リリース資源の管理を行うことができます。
- Channelsバンドル
- Versions、デプロイ可能なアップデートを構成するウェブアセットとメタデータです。
- チャンネル、リリースを選択したプラットフォーム、アプリケーション バージョン、オペレーティング システム、またはメタデータ グループに送信するのに役立ちます。
- 観測可能性データ、採用、失敗、ロールバック アクティビティ、およびデバイスごとのステータスを含みます。
一般的なリクエストは予測可能なシーケンスを遂行します。パイプラインはバンドルを作成または準備し、JSON メタデータをCapgoに送信し、返されたステータスを確認し、次に適切なチャネルにリリースを割り当てます。後日、更新を受け取ったデバイスを確認するためのクエリが実行できます。
キーアイデア: Capgo JSON をリリース管理契約として扱い、単なるデータ形式としてみなすのではなく、すべてのフィールドがアプリケーション更新の公開、ターゲット設定、監視、または回復をサポートするようにする必要があります。
Typed JSON の利点
型付きペイロードは TypeScript コードベースにおける曖昧性を軽減します。バージョン ID は文字列、ロールアウトフラグはブール値、デバイス数は数値でなければなりません。自動化を接続する前に、リクエストとレスポンスのインターフェイスを定義し、必須フィールドと可空値を検証する必要があります。
読み物: API と TypeScript を使用する方法について学びましょう。.
3 つの習慣をすべての統合に持つこと:
- ステータスコードとレスポンスボディを一緒に検査すること、なぜHTTP成功だけでは展開完了を表すことができないか
- 戻り値の識別子を保存する、特にバンドル、バージョン、チャンネルIDなど、次回の呼び出しに使用するために
- 安全にログする、API キーと機器の機密情報を除く
この基盤を使用した以下の参照セクションでは、認証、アップロードペイロード、チャンネルスキーマ、ターゲットクエリ、エラー オブジェクトの説明が含まれます。現在のエンドポイント名とフィールド定義については、Capgo のドキュメントを確認してください。 capgo.app.
{ “認証”: “Bearer YOUR_CAPGO_API_キー”, “コンテンツタイプ”: “application/json”, “受容”: “application/json” }
{ “成功”: true, “バンドルID”: “com.example.field-app”, “バージョン”: “2.4.0”, “ステータス”: “アップロード”, “バンドルUUID”: “生成されたバンドル識別子”, “作成日時”: “2026-01-15T10:30:00Z” }
{ “デフォルトバージョン”: “2.4.3”, “自動更新”: true, “ロールバック保護”: { “有効”: true, “フォールバックバージョン”: “2.4.2” } }
{ “データ”: [ { “タイムスタンプ”: “2026-02-04T09:00:00Z”, “インストール”: 842, “ロールバック”: 3, “エラー”: 11 }, { “タイムスタンプ”: “2026-02-04T10:00:00Z”, “インストール”: 1276, “ロールバック”: 2, “エラー”: 8 } ], “サマリー”: { “合計インストール”: 2118, “合計ロールバック”: 5, “合計エラー”: 19 } }
{ “エラー”: { “code”: “INVALID_PARAMETER”, “メッセージ”: “バージョンフィールドは必須です”, “フィールド”: “バージョン”, “詳細”: { “期待”: “文字列”, “受け取った”: “null” } } }
