アプリの追加と管理

APIを使用してBitriseで新しいアプリをセットアップします。アプリを追加し、SSHキーを生成して、アプリの初期構成をセットアップします。

さらに、たとえば、単一のユーザーまたは特定のワークスペースに属するすべてのアプリを一覧表示できます。

APIを使用して新しいアプリを追加する

表1 BitriseAPIを使用して新しいアプリを追加する際に使用されるエンドポイント

エンドポイント

関数

POST / apps / register

新しいアプリを追加します。

POST / apps / {app-slug} / register-ssh-key

SSHキーを特定のアプリに追加します。

POST / apps / {app-slug} / finish

アプリケーション追加プロセスの最後にアプリケーションを保存します。

POST /apps/{app-slug}/bitrise.yml

アプリケーションの新しいbitrise.ymlをアップロードします。


HTTPS GitURLを使用するアプリ

手順と例は、SSH gitURLを使用してプライベートアプリを追加することを目的としています。 HTTPS git URLを使用してアプリを追加する場合は、SSHキーの追加をスキップできます。

  1. を呼び出してアプリを登録します register エンドポイントとすべての必要なパラメータの設定。

    gitプロバイダー、リポジトリURL、プロバイダーに表示されるリポジトリのスラッグ、およびリポジトリの所有者のスラッグを設定する必要があります。

    curl -X POST -H 'Authorization: ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/register' -d \
    '{
          "provider": "github",
          "is_public": false,
          "repo_url": "git@github.com:api_demo/example-repository.git",
          "type": "git",
          "git_repo_slug": "example-repository",
          "git_owner": "api_demo"
     }'      

    組織にアプリを追加する場合は、カールリクエストの最後に組織を含める必要があります。

    curl -X POST -H 'Authorization: ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/register' -d \
    '{
         "provider": "github",
         "is_public": false,
         "repo_url": "git@github.com:api_demo/example-repository.git",
         "type": "git",
         "git_repo_slug": "example-repository",
         "git_owner": "api_demo",
         "organization_slug": ""
     }'
  2. 完了したら、 register-ssh-key ビルドの実行時にBitriseがリポジトリのクローンを作成できるように、作成したSSHキーを設定するエンドポイント。

    SSHの秘密鍵と公開鍵の両方を提供する必要があります。秘密鍵を手動でコピーする場合は、すべての改行をエスケープする必要があることに注意してください。 \n

    公開鍵をgitプロバイダーに自動的に登録するかどうかを設定することもできます。 is_register_key_into_provider_service パラメータをtrueまたはfalseに設定します。

    curl -X POST -H 'Authorization: ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/register-ssh-key' -d \
    '{
        "auth_ssh_private_key": "your-private-ssh-key",
        "auth_ssh_public_key": "your-public-ssh-key",
        "is_register_key_into_provider_service": false
     }'  
  3. を呼び出してアプリの登録プロセスを完了します finish 終点。

    このエンドポイントを使用すると、アプリを構成できます。プロジェクトタイプ、ビルドを実行するスタック、および初期構成設定を設定します。

    また、環境変数を設定したり、アプリケーションの所有者となるワークスペースをすぐに指定したりすることもできます。注意してください mode パラメータは、の値に設定する必要があります manual

    curl -X POST -H 'Authorization: ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/finish' -d \
    '{
         "project_type": "ios",
         "stack_id": "osx-vs4mac-stable",
         "config": "default-ios-config",
         "mode": "manual",
         "envs": {
               "env1": "val1",
               "env2": "val2"
         },
         "organization_slug": "e1ec3dea540bcf21"
     }'
    

既存のアプリの管理

表1 BitriseAPIを使用した既存のアプリの管理に関連するエンドポイント

エンドポイント

関数

GET / apps

アプリのリストを取得します。

GET / apps / {app-slug}

特定のアプリを入手してください。

GET /apps/{app-slug}/bitrise.yml

特定のアプリのbitrise.ymlを取得します。

GET / apps / {app-slug} / branchs

アプリのリポジトリのブランチを一覧表示します。

GET / organizations / {org-slug} / apps

ワークスペースのアプリのリストを取得します。

GET / users / {user-slug} / apps

ユーザー向けのアプリのリストを取得します。


1つ以上のアプリに関するGETリクエストへの応答には、アプリスラッグ、そのプロジェクトタイプ、gitプロバイダー、リポジトリの所有者、およびURLが含まれます。

{
  "data": [
    {
      "slug": "eeeeefffff00000",
      "title": "sample-app",
      "project_type": "android",
      "provider": "github",
      "repo_owner": "example-user",
      "repo_url": "git@github.com:example-user/sample-app.git",
      "repo_slug": "android-gradle-kotlin-dsl",
      "is_disabled": false,
      "status": -1,
      "is_public": false,
      "owner": {
        "account_type": "organization",
        "name": "Test Org",
        "slug": "fffffeeeee00000"
      },
      "avatar_url": null
    },
    {

任意のアプリの既存のbitrise.ymlファイルをダウンロードすることもできます。応答には完全なYAML構成が含まれます。