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

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

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

EndpointsFunctionRequired role on the app's team
GET/apps/{app-slug}/android-keystore-filesAndroidのキーストアファイルの一覧を取得しますOwner または Admin
POST/apps/{app-slug}/android-keystore-filesAndroidのキーストアファイルを作成しますOwner または Admin
DELETE/apps/{app-slug}/android-keystore-files/{android-keystore-file-slug}Androidのキーストアファイルを削除しますOwner または Admin

アプリのAndroidキーストアファイルの一覧表示Click to copy link​

必要なロール

Bitrise APIを使用してAndroidのキーストアファイルを管理するには、アプリのチームで admin または owner ロールが必要です。

ユーザーロールの全リストとロールの早見表については、User roles on app teamsをご確認ください。

android-keystore-filesエンドポイントのGETメソッドを使用して、アプリのAndroidキーストアファイルの一覧を取得します。返されるデータには、ファイルの名前、サイズ、現在のステータスなどが含まれます。

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

  • app slug

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

  • next: レスポンス内の最初のファイルのslug(文字列)
  • limit: 1ページあたりの要素の最大数(整数)。デフォルトは50です。
アプリのすべてのAndroid keystore filesを取得する

リクエスト:

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キーストアファイルの作成とアップロードClick to copy link​

必要なロール

Bitrise APIを使用してAndroidのキーストアファイルを管理するには、アプリのチームで admin または owner ロールが必要です。

ユーザーロールの全リストとロールの早見表については、User roles on app teamsをご確認ください。

APIを使用してアプリにAndroidのキーストアファイルを追加するには、次の操作が必要です。

  1. upload_file_nameおよびupload_file_sizeパラメーターを指定して、android-keystore-filesエンドポイントのPOSTメソッドを呼び出します。

  2. レスポンスのupload_url parameterを使用して、ファイルをAWSにアップロードします。

  3. uploadedエンドポイントへのPOST呼び出しでファイルのアップロードを確認します。

    これにより、ファイルのprocessedフラグがtrueに設定されます。このフラグは、その後変更できません。

作成呼び出しでは、キーストアの認証情報をファイルと一緒に保存するために、次のオプションのパラメーターも使用できます。

  • password: キーストアのパスワード。
  • alias: 使用する鍵のエイリアス。
  • private_key_password: 鍵のパスワード。
  • keystore_file_name: キーストアのファイル名。アプリに別のキーストアファイルがすでに存在する場合は必須です。
新しい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,"password":"KEYSTORE-PASSWORD","alias":"KEY-ALIAS","private_key_password":"KEY-PASSWORD","keystore_file_name":"simplesample.jks"}'

レスポンス:

{
"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": ""
}
}
}

ファイル名、サイズ、slug、および署名済みアップロードURLが取得されます(変更可能ないくつかの属性とともに)。この署名済みアップロードURLは一時的なリンクであり、Androidのキーストアファイルを保存先にアップロードする際に使用します。

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

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キーストアファイルのダウンロードClick to copy link​

アップロードされたAndroidのキーストアファイルは、General File Storageに保存されます。android-keystore-filesエンドポイントからダウンロードURLを取得することで、いつでもファイルを取得できます。

エンドポイントを呼び出すには、uploading the keystore file時に返されるファイルのslugと、app slugが必要です。

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

レスポンスにはdownload_urlプロパティが含まれ、その中に文字列としてURLが格納されています。このURLを使用して、ファイル自体をダウンロードできます。

download_urlの利用可否

download_urlは、ファイルのis_protected属性がfalseの場合にのみ生成される点にご注意ください。