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

APIキーを使ったAppleサービスへの接続

APIキーを使用してAppleサービス(App Store ConnectやApple Developer Portalなど)に接続するには、APIキーの生成、Bitriseでの認証データの追加、そしてアプリへのキーの割り当てが必要です。

APIキー認証は、BitriseをAppleサービスに接続する際に推奨される方法です。Apple Services connectionページにはAPIキーを50個まで追加できますが、アプリで使用できるのは1つだけです。

Step 入力の変更は不要

この方法では、Apple API キーによる認証に関連するすべてのStep inputsが、接続の設定後に自動的に入力されます。これらのStep入力フィールドを手動で変更する必要はまったくありません。

BitriseでAPIキー認証データを追加するClick to copy link​

Workspace設定ページでAPIキー認証データを追加できます。ここでは複数のAPIキーを追加できます。プロジェクトごとに異なるAPIキーを選択し、Bitrise CIまたはBitrise Release Managementのいずれかに使用できます。

  1. App Store Connectで、Users and Accessの下にある管理者アクセス権を持つ新しいAPIキーを生成します。

    Bitrise上でキーの名前、key ID、issuer IDが必要です。

    必要条件
    • APIキーはチームのAPIキーである必要があります。個人のAPIキーは使用できません。

      apple-app-store-connect.png

    • APIキーには、App Store上でAdminロールを設定する必要があります。設定していない場合、ビルドは失敗します。

    • Bitriseでは、APIキーのデータを追加するにはworkspaceのOwnerまたはManagerである必要があります。詳細については、Workspaceレベルのロールを参照してください。

  2. Bitriseで、ドロップダウンメニューからworkspaceを選択し、Settingsに移動します。

  3. 左側でIntegrationsを選択します。

  4. App Store Connectを選択します。

  5. Add API keyをクリックします。

    必要なロール

    ボタンが表示されない場合、workspace内でViewerまたはContributorのロールしか持っていないことが原因です。OwnerまたはManagerのいずれかである必要があります。

    詳細については、Workspaceレベルのロールを参照してください。

    api-key-app-store.png

  6. 必要な項目をすべて入力します。

    • Name: 生成したAPIキーの名前です。
    • Issuer ID: issuer IDを取得するには、App Store Connectにログインし、Users and Accessを選択してからAPI Keysタブを選択します。issuer IDはページの上部付近に表示されます。issuer IDをコピーするには、IDの横にあるCopyをクリックします。
    • Key ID: 新しいAPIキーの生成に成功すると、App Store Connectがkey IDを表示します。

    api-key-dialog.png

  7. APIキーがApple Enterprise APIキーの場合は、Use for Enterprise Program APIにチェックを入れます。

    api-key-enterprise.png

  8. .p8ファイルをアップロードします。アップロードフィールドにドラッグ&ドロップするか、クリックしてコンピューターからファイルを選択してください。

  9. Add API keyをクリックします。

完了すると、このアカウントでアクセス権を持つ任意のアプリに、このAPIキーを割り当てられるようになります。以降、そのアプリはこのAPI接続を使用してApp Store Connectにアクセスします。

プロジェクトへのAPIキー認証の割り当てClick to copy link​

プロジェクトでAppleサービスにAPIキー認証を使用するには、次の操作が必要です。

  • BitriseでAPIキーを追加する: 同じアカウントに複数のAPIキーを追加できます。APIキーがApple Enterprise APIキーの場合は、追加時にUse for Enterprise Program APIにチェックを入れてください。
  • プロジェクトにAPIキーを割り当てる: 各プロジェクトに割り当てられるAPIキーは1つだけです。

プロジェクトにAPIキーを割り当てるには、次の手順を実行します。

  1. プロジェクトに対するAdminのロールを持つユーザー、またはEdit workflow権限を持つカスタムロールを持つユーザーで、Bitrise上のプロジェクトを開きます。

  2. プロジェクトのメインページで、Project settingsボタンをクリックします。

  3. 左側でIntegrationsを選択します。

  4. Storesタブを選択します。

  5. App Store Connectセクションを見つけます。

    add-api-key-apple.png

  6. API key authentication (recommended)オプションを見つけます。

  7. Add API keyをクリックします。

    同じAPIキーを使う複数のプロジェクト

    Add API keyボタンを使用すると、Bitriseアカウントに新しいApp Store Connect APIキーを追加できます。アクセス権を持つ他のプロジェクトでも、このAPIキーを使用できます。

  8. このプロジェクトで使用するAPI keyを選択します。

これでStepは、ビルド中にApp Store ConnectまたはApple Developer Portalに接続できるようになります。

Apple Enterpriseユーザー向けのAPIキー認証Click to copy link​

Enterprise developer programに参加しているAppleアカウントでも、APIキーベースの認証を使用できます。

Enterpriseアカウントで引き続きApple ID認証を使用している場合は、次の理由からAPIキー認証への切り替えを強くお勧めします。

  • より信頼性が高く、安全です。
  • 30日ごとに再認証する必要がありません。
  • Apple ID認証方式は、将来的に非推奨になる予定です。

認証方式を変更するには、次の手順を実行します。

  1. まだ行っていない場合は、BitriseでAPIキーを追加し、必ずUse for Enterprise Program APIにチェックを入れてください。

  2. APIキーを割り当てて、Bitrise上のプロジェクトに設定します。

    Apple ID connectionを残しておく

    Apple ID connectionは削除しないことを強くお勧めします。APIキー接続に問題が発生した場合、Apple IDベースの認証に安全にロールバックできます。

  3. AppleサービスへのアクセスにApple ID認証を使用しているすべてのStep inputsを調整します。以下のStepsが対象です。

    • Xcode Archive & Export for iOS: バージョン5.3.0以降。automatic_code_signing入力をapi-keyに設定します。
    • Xcode Build for Testing: バージョン3.1.0以降。automatic_code_signing入力をapi-keyに設定します。
    • Manage iOS Code Signing: バージョン2.1.0以降。apple_service_connection入力をapi-keyに設定します。
    • Export iOS and tvOS Xcode archive: バージョン4.6.0以降。automatic_code_signing入力をapi-keyに設定します。

同じプロジェクトで複数のAPIキーを使うClick to copy link​

Bitrise websiteでは、プロジェクトごとに設定できるAPI接続は1つだけです。つまり、そのプロジェクトが扱えるcode signingファイルは1つのAppleデベロッパチームのものに限られます。APIキーが認可するのは、単一のデベロッパチームのみだからです。

api-key-chart.png

Bitriseプロジェクトで複数のデベロッパチームのcode signingを扱う必要がある場合は、追加のAPIキーをStep inputsとして渡すことができます。これにより、Bitriseが管理するAPI接続が上書きされます。利用できる入力はStepによって異なります。

Step入力
  • Xcode Archive & Export for iOS
  • Xcode Build for Testing
  • Manage iOS Code Signing
  • Export iOS and tvOS Xcode archive
  • api_key_path: APIキーのローカルファイルパスまたはダウンロードURL。
  • api_key_id: App Store Connectのkey ID。
  • api_key_issuer_id: App Store Connectのissuer ID。
  • api_key_enterprise_account: キーがApple Enterprise Programアカウントに属しているかどうかをyesまたはnoで指定します。
  • fastlane
  • Deploy to App Store Connect with Deliver
  • api_key_path: APIキーのローカルファイルパスまたはダウンロードURLです。ファイル名にkey IDを埋め込みます。key ID専用の入力はありません。
  • api_issuer: App Store Connectのissuer ID。
GUIでの入力

Bitrise Workflow EditorのグラフィカルUIでは、Appleサービスにアクセスできる各StepのConfigurationタブにあるApp Store Connect connection override入力グループの下でこれらの入力を確認できます。