iOS code signingファイルの管理
このガイドでは、Bitrise APIを使用してiOSのcode signingファイルを管理する方法について説明します。UIで同じことを行う方法について詳しく知りたい場合は、iOS code signingをご覧ください。
APIを使用すると、iOSのcode signingファイルのアップロード、更新、一覧表示、削除を行えます。このガイドでは、それらのcode signingエンドポイントの使用方法と順序について説明します。
| エンドポイント | 機能 | アプリチームで必要なロール |
|---|---|---|
| POST/apps/{app-slug}/provisioning-profiles | プロビジョニングファイルを作成する | オーナーまたは管理者 |
| POST/apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug}/uploaded | アップロード処理を確認する | オーナーまたは管理者 |
| PATCH/apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug} | アップロード済みのプロビジョニングファイルを更新する | オーナーまたは管理者 |
| GET/apps/{app-slug}/provisioning-profiles | アップロード済みのプロビジョニングファイルの一覧を取得する | オーナーまたは管理者 |
| GET/apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug} | 特定のプロビジョニングファイルのデータを取得する | オーナーまたは管理者 |
| DELETE/apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug} | アップロード済みのプロビジョニングファイルを削除する | オーナーまたは管理者 |
| エンドポイント | 機能 | アプリチームで必要なロール |
|---|---|---|
| POST/apps/{app-slug}/build-certificates | ビルド証明書を作成する | オーナーまたは管理者 |
| POST/apps/{app-slug}/build-certificates/{build-certificate-slug}/uploaded | アップロード処理を確認する | オーナーまたは管理者 |
| PATCH/apps/{app-slug}/build-certificates/{build-certificate-slug} | アップロード済みのビルド証明書を更新する | オーナーまたは管理者 |
| GET/apps/{app-slug}/build-certificates | アップロード済みのビルド証明書の一覧を取得する | オーナーまたは管理者 |
| GET/apps/{app-slug}/build-certificates/{build-certificate-slug} | 特定のビルド証明書のデータを取得する | オーナーまたは管理者 |
| DELETE/apps/{app-slug}/build-certificates/{build-certificate-slug} | アップロード済みのビルド証明書を削除する | オーナーまたは管理者 |
iOSのcode signingファイルをアップロードするClick to copy link
Bitrise APIを使用してiOSのcode signingファイルを管理するには、アプリチームで管理者またはオーナーのロールが必要です。
詳細なユーザーロールの一覧とロールのチートシートについては、Bitrise CIのロールと権限をご確認ください。
任意のBitriseアプリに、iOSのcode signingファイル(.p12証明書 またはプロビジョニングプロファイルのいずれか)をアップロードできます。このプロセスでは新しいcode signingファイルは作成されません。既存のファイル(Apple Developer Portalで作成してダウンロードしたもの)をAWS URLにアップロードします。これは、Bitrise websiteでcode signingファイルをアップロードするのと機能的に同じです。iOSのcode signingファイルの管理 - 手動プロビジョニングを参照してください。
APIを使用してiOSのcode signingファイルをアップロードするには、次の手順に従います。
-
provisioning-profilesまたはbuild-certificatesエンドポイントのPOSTメソッドを呼び出して、10分で期限切れになる一時的な署名付きアップロードURLを作成します。この呼び出しには、既存のcode signingファイル(証明書またはプロビジョニングプロファイル)と2つのパラメータが必要です。
upload_file_name: 既存のcode signingファイルへのファイルパス。例:/path/to/sample.p12。upload_file_size: ファイルのサイズ(バイト単位)。
// Calling the endpoint to create the temporary upload URLcurl -X POST -H 'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/provisioning-profiles' -d '{"upload_file_name":"sample.provisionprofile","upload_file_size":2047}'// The successful response: you will need the "upload_url" and the "slug".{"data":{"upload_file_name":"sample.provisionprofile","upload_file_size":2047,"slug":"01C6FA6P6HRQT5PQ8RMMVVXE6W","processed":false,"is_expose":true,"is_protected":false,"upload_url":"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"}} -
最初の呼び出しに対するレスポンスには、
upload_urlパラメータが含まれています。これとupload_file_nameパラメータを使用して、curl呼び出しでファイルをAWSにアップロードする必要があります。curl -T sample.provisionprofile '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' -
uploadedエンドポイントへのPOST呼び出しでファイルのアップロードを確認します。最初のPOST呼び出しに対するレスポンスのslugを使用します。これにより、ファイルの
processedフラグがtrueに設定されます。このフラグは、その後変更できません。curl -X POST -H 'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/provisioning-profiles/FILE-SLUG/uploaded'
アップロード済みのiOSのcode signingファイルを更新するClick to copy link
PATCHメソッドを使用して、アップロード済みのiOSのcode signingファイルに軽微な更新を行えます。ファイルをBitriseにアップロード済みの場合は、Code Signing & Filesタブで変更内容を視覚的に確認できます。
Bitrise APIを使用してiOSのcode signingファイルを管理するには、アプリチームで管理者またはオーナーのロールが必要です。
詳細なユーザーロールの一覧とロールのチートシートについては、Bitrise CIのロールと権限をご確認ください。
たとえば、プロビジョニングプロファイルを保護対象にするには、プロビジョニングプロファイルのis_protectedフラグをtrueに設定します。
curl -X PATCH -H 'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/provisioning-profiles/PROVISIONING-PROFILE-SLUG -d '{"is_protected":true}'
ビルド証明書の場合も上記と同じ属性を設定できますが、パスワードも変更できます。
curl -X PATCH -H 'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/build-certificates/BUILD-CERTIFICATE-SLUG -d '{"certificate_password":"s0m3-v3ry-s3cr3t-str1ng"}'
certificate_passwordの利用可否download_urlと同様に、certificate_passwordは、ファイルのis_protected属性がfalseの場合にのみレスポンスに返される点に注意してください。
アップロードしたファイルのis_protected、is_exposed、processed属性を設定できます。
is_protectedフラグがtrue,に設定されると、それ以降変更できません。is_protectedの値がtrueの場合、is_exposeフラグを別の値に設定することはできません。processedフラグがtrueに設定されると、その値はそれ以降変更できません。
特定のiOSのcode signingファイルのデータを取得するClick to copy link
Bitrise APIを使用してiOSのcode signingファイルを管理するには、アプリチームで管理者またはオーナーのロールが必要です。
詳細なユーザーロールの一覧とロールのチートシートについては、Bitrise CIのロールと権限をご確認ください。
provisioning-profilesおよびbuild-certificatesエンドポイントのGETメソッドを使用して、特定のiOSのcode signingファイルのデータを取得します。返されるデータには、ファイルの名前、サイズ、ダウンロードURL、および現在のステータスなどが含まれます。
必要なパラメータは次のとおりです。
- アプリのslug
- ファイルのslug
リクエスト:
curl -X GET -H 'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/provisioning-profiles/PROVISIONING-PROFILE-SLUG'
レスポンス:
{
"data": {
"upload_file_name":"sample.provisionprofile",
"upload_file_size":2047,
"slug":"01C6FA6P6HRQT5PQ8RMMVVXE6W",
"processed":false,
"is_expose":true,
"is_protected":false,
"download_url":"https://concrete-userfiles-production.s3-us-west-2.amazonaws.com/prov_profile_documents/uploads/80144/original/sample.provisionprofile?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAIOC7N256G7J2W2TQ%2F20180322%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20180322T091652Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=6dd7bb3db72aafb2d434da7b1a8f80a82a3a7a0276e84620137ed64de5025ab2"
}
}
download_urlの利用可否download_urlは、ファイルのis_protected属性がfalseの場合にのみ生成される点に注意してください。
アプリのiOSのcode signingファイルを一覧表示するClick to copy link
Bitrise APIを使用してiOSのcode signingファイルを管理するには、アプリチームで管理者またはオーナーのロールが必要です。
詳細なユーザーロールの一覧とロールのチートシートについては、Bitrise CIのロールと権限をご確認ください。
アプリに属するiOSのcode signingファイルがいくつあるか気になりますか?provisioning-profilesおよびbuild-certificatesエンドポイントのGETメソッドを使用して一覧を取得できます。
必要なパラメータは次のとおりです。
- アプリのslug
オプションのパラメータは次のとおりです。
- next: レスポンス内の最初 のファイルのslug(文字列)
- limit: 1ページあたりの要素数の最大数(整数)。デフォルトは50です。
リクエスト:
curl -X GET -H 'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/provisioning-profiles'
レスポンス:
{
"data": [
{
"upload_file_name":"sample.provisionprofile",
"upload_file_size":2047,
"slug":"01C6FA6P6HRQT5PQ8RMMVVXE6W",
"processed":false,
"is_expose":true,
"is_protected":false
},
{
"upload_file_name":"sample2.provisionprofile",
"upload_file_size":2047,
"slug":"01C6FA6P6HRQT5PQ8RMMVVXE5T",
"processed":true,
"is_expose":true,
"is_protected":true
}
],
"paging": {
"page_item_limit": 50,
"total_item_count": 2
}
}
</content> </invoke>