メインコンテンツまでスキップ

Release Management API

Bitriseでは、Release Management向けのREST APIを提供しています。APIのベースURLは です。

APIには、次の2つのバージョンがあります。

APIでは、GUIで利用できるのと同じ機能を使用できます。次のことができます。

  • Connect app。
  • プリセットを設定します。
  • release candidate stageや承認ステージを含む、すべてのステージでリリースを管理します。
  • アプリを配布します。

サブAPIClick to copy link​

v2のAPIは4つのサブAPIに分かれており、それぞれに独自のベースURLがあります。

サブAPI説明ベースURL
Appsconnected apps、インストール可能アーティファクト、プリセット、パブリックアセット、送信Webhook、Apple App Storeドラフトバージョンを扱います。https://api.bitrise.io/release-management/v2/apps/v1
Build Distributionsテスターグループ、テスター、ビルド配布を扱います。https://api.bitrise.io/release-management/v2/build-distributions/v1
Store Releasesアプリバージョン、承認、ベータ配布、App StoreとGoogle Playの両方のストアリリースを扱います。https://api.bitrise.io/release-management/v2/store-releases/v1
Code Pushデプロイと更新を扱います。https://api.bitrise.io/release-management/v2/code-push/v1

v1からv2への移行Click to copy link​

v1とv2の主な構造上の違いは次のとおりです。

  • アプリの識別: v1では、アプリIDはパスパラメータでした(例: /apps/{app_id}/installable-artifacts)。v2では、app_idが該当するサブAPIにクエリパラメータとして渡されます。
  • Tester groupとビルド配布: AppsサブAPIから、専用のBuild DistributionsサブAPIに移動しました。
  • Code Pushパッケージの名称変更: v1のCode Pushにおけるpackagesリソースは、v2ではupdatesと呼ばれます。
  • ストアリリース: Apple App StoreとGoogle Play storeのrelease managementは、現在Store ReleasesサブAPIに含まれています。

非推奨となった各v1エンドポイントの説明には、使用すべき同等のv2エンドポイントが明記されています。詳細な一覧については、APIのドキュメントを参照してください。

認証Click to copy link​

認証はBitrise APIと同じ方法で機能します。API呼び出しを認証するには、パーソナルアクセストークンまたはWorkspaceトークンが必要です。

一部のエンドポイントは、Release managerロールを持つユーザーのみが利用できます。また、一部のエンドポイントはStandardプランでのみ利用できます。通常、これらのエンドポイントは、App Store審査へのアプリの提出や、App StoreまたはGoogle Playへのアプリのリリースなど、エンドユーザー向けの機能にアクセスするために使用されます。

これらのロールに紐づくエンドポイントにアクセスしようとすると、403 Permission deniedレスポンスが返されます。

ドキュメントClick to copy link​

APIエンドポイントの詳細なドキュメントは、APIのドキュメントで確認できます。サイト上ですべてのエンドポイントをテストできます。

技術的な詳細に加えて、特定のBitrise支払いプランでエンドポイントが利用可能かどうかも確認できます。

App Store APIのローカリゼーションコードClick to copy link​

App Store APIへの特定の呼び出しでは、ローカリゼーションコードが必要になる場合があります。たとえば、iOSリリース用のWhat to testの説明を作成する際に、その説明を複数の言語で用意する必要がある場合があります。サポートされているローカリゼーションコードは、Appleの資料で確認できます。

関連情報