Skip to main content

Android キーストア ファイルの管理

概要

You can create and upload Android keystore files to Bitrise for the purposes of Android code signing, using the Bitrise API. Your account must be an owner or an admin on the app's team to access these features.

このガイドでは、Bitrise API を使用して Android キーストア ファイルを管理する方法について説明します。 UI で同じことを行う方法について詳しく知りたい場合は、こちらをご覧ください。Android コード署名.

表1 Android キーストア ファイルに関連するエンドポイント

エンドポイント

関数

アプリのチームで必要な役割

GET/apps/{app-slug}/android-keystore-files

Android キーストア ファイルのリストを取得する

所有者または管理者

POST/apps/{app-slug}/android-keystore-files

Android キーストア ファイルを作成する

所有者または管理者

DELETE/apps/{app-slug}/android-keystore-files/{android-keystore-file-slug}

Android キーストア ファイルを削除する

所有者または管理者

アプリの Android キーストア ファイルの一覧表示

必要な役割

Bitrise API を使用して Android キーストア ファイルを管理するには、アプリのチームで管理者または所有者の役割を持っている必要があります。

ユーザーの役割と役割のチートシートの完全なリストについては、以下を確認してください。アプリ チームのユーザー ロール.

の GET メソッドを使用して、アプリの Android キーストア ファイルのリストを取得します。 android-keystore-files 終点。返されるデータには、特に、ファイルの名前、サイズ、および現在のステータスが含まれます。

必須パラメーターは次のとおりです。

  • アプリスラッグ

オプションのパラメーターは次のとおりです。

  • next: 応答の最初のファイルのスラッグ (文字列として)

  • limit: ページあたりの要素の最大数 (整数として)。デフォルトは 50 です。

例1 アプリのすべての Android キーストア ファイルを取得する

リクエスト：

curl -X GET -H  'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/android-keystore-files'

応答：

{
  "data": [
    {
      "upload_file_name": "simplesample.jks",
      "upload_file_size": 2062,
      "slug": "01GDFZW5DZED3DQD4VK835FKTP",
      "processed": true,
      "is_expose": true,
      "is_protected": false,
      "user_env_key": "ANDROID_KEYSTORE",
      "exposed_meta_datastore": {
        "PASSWORD": "",
        "ALIAS": "",
        "PRIVATE_KEY_PASSWORD": ""
      }
    }
  ],
  "paging": {
    "total_item_count": 1,
    "page_item_limit": 50
  }

Android キーストア ファイルの作成とアップロード

必要な役割

Bitrise API を使用して Android キーストア ファイルを管理するには、アプリのチームで管理者または所有者の役割を持っている必要があります。

ユーザーの役割と役割のチートシートの完全なリストについては、以下を確認してください。アプリ チームのユーザー ロール.

API を使用してアプリに Android キーストア ファイルを追加するには、次のことを行う必要があります。

  1. の POST メソッドを呼び出すandroid-keystore-files エンドポイントupload_file_nameとupload_file_sizeパラメーター。

  2. を使用して AWS にファイルをアップロードします。upload_url parameter 応答から。

  3. の POST 呼び出しでファイルのアップロードを確認します。uploaded終点。

    これにより、ファイルの処理済みフラグがtrue.このフラグは後で変更できません。

例1 新しい Android キーストア ファイルの作成とアップロード

ファイルの作成:

curl -X POST -H 'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/android-keystore-files' -d '{"upload_file_name":"simplesample.jks","upload_file_size":2062}'

応答：

{
  "data": {
    "upload_file_name": "simplesample.jks",
    "upload_file_size": 2062,
    "slug": "01GDFYTF2DXZZSWGMCF0ZTVSB9",
    "processed": false,
    "is_expose": true,
    "is_protected": false,
    "upload_url": "https://concrete-userfiles-production.s3.us-west-2.amazonaws.com/project_file_storage_documents/uploads/129261/original/simplesample.jks?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIV2YZWMVCNWNR2HA%2F20220921%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20220921T120206Z&X-Amz-Expires=600&X-Amz-SignedHeaders=content-length%3Bhost&X-Amz-Signature=ce3c66fa144ba6ca9478cff3b72c49e024779f64ba961ddfc84060f65ea92562",
    "user_env_key": "ANDROID_KEYSTORE",
    "exposed_meta_datastore": {
      "PASSWORD": "",
      "ALIAS": "",
      "PRIVATE_KEY_PASSWORD": ""
    }
  }
}

ファイル名、そのサイズ、スラッグ、署名済みのアップロード URL が取得されます (変更可能ないくつかの属性と共に)。この署名済みのアップロード URL は、Android キーストア ファイルを目的の場所にアップロードするために使用する一時的なリンクです。

の値を使用して AWS にファイルをアップロードするupload_urlパラメータ:

curl -T simplesample.jks 'https://concrete-userfiles-production.s3-us-west-2.amazonaws.com/build_certificates/uploads/30067/original/certs.p12?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAIOC7N256G7J2W2TQ%2F20180216%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20180216T124240Z&X-Amz-Expires=600&X-Amz-SignedHeaders=content-length%3Bhost&X-Amz-Signature=2bf42176650f00405abfd7b7757635c9be16b43e98013abb7f750d3c658be28e'

アップロードの確認:

curl -X POST -H 'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/android-keystore-files/ANDROID-KEYSTORE-FILE-SLUG/uploaded'

Android キーストア ファイルのダウンロード

アップロードされた Android キーストア ファイルは、General File Storage に保存されます。ダウンロード URL を取得すると、いつでも取得できます。 generic-project-files 終点。

エンドポイントを呼び出すには、次のときに返されるファイル スラッグが必要です。 キーストア ファイルのアップロード そしてその アプリのスラッグ。

curl -X GET "https://api.bitrise.io/v0.1/apps/APP-SLUG/generic-project-files/FILE-SLUG" -H "accept: application/json" -H "Authorization: ACCESS-TOKEN"

応答には次の内容が含まれます download_url プロパティ。文字列に URL が含まれます。その URL を使用してファイル自体をダウンロードできます。

このセクションの内容: