App Store Connect の APIキーを作成する方法
Shipcue は、Apple の App Store Connect API を使って審査ステータスを読み取り、バージョンをリリースします。そのため、追跡したいアカウントごとに APIキーが必要です。作成手順をステップごとに説明します。
Team キーと Individual キー、どちらにする?
App Store Connect の APIキーには 2 種類あります。Shipcue はどちらにも対応しています。
- Team キー(推奨)。チームの Admin が作成します。キーに設定したロールの権限で、チームのすべてのアプリを閲覧できます。Issuer ID が付きます。
- Individual キー。ご自身のユーザープロファイルで作成します。ユーザー本人と同じロールとアプリへのアクセス権を持つため、自分が見られるアプリだけが対象です。Issuer ID はありません。「Generate Individual API Keys」権限が必要で、チームの Admin から付与してもらえます。
クライアントの仕事をしている場合は、Individual キーのほうが手軽なことが多いです。Admin にキーを作ってもらう必要はなく、必要なのはこの権限だけです。
キーにはどのロールを付ける?
目的に足りる、できるだけ小さなロールを選びます。
- App Manager: Shipcue に最適です。バージョンのリリースと取り下げ、段階的リリースの制御、プッシュ通知に必要な Webhook の設定ができ、ユーザー管理はできません。
- Admin: 使えますが、ユーザーの追加や削除もできてしまいます。スマートフォンに置くキーには避けてください。
- Developer: 閲覧のみ。Shipcue を開いたときや更新したときに最新のステータスは表示されますが、プッシュ通知の設定も、リリースも、取り下げもできません。
Shipcue 専用に新しいキーを作成してください。CI やほかのツールが使っているキーは流用しないでください。片方を失効させても、もう片方に影響が出ません。
Team キーを作成する
-
APIキーのページを開く
Admin として、ブラウザーで App Store Connect にサインインします。Users and Access を開き、Integrations タブを選び、左の列の App Store Connect API を選びます。ページに Request Access ボタンが表示されている場合は、Account Holder が一度だけ API アクセスを申請する必要があります。
-
キーを生成する
Team Keys が選択されていることを確認し、Generate API Key(または + ボタン)をクリックします。あとで見分けられる名前、たとえば「Shipcue」を付けます。Access では App Manager を選び、Generate をクリックします。
-
.p8 ファイルをダウンロードする
新しいキーの横にある Download API Key をクリックします。ダウンロードできるのは 1 回だけで、Apple はコピーを保管しません。ファイル名は AuthKey_ に Key ID が続く形式で、たとえば AuthKey_ABCD123456.p8 です。パスワードマネージャーなど、安全な場所に保管してください。
-
Issuer ID をコピーする
Issuer ID は、キー一覧の上に表示されています。69a6de8f-3c2e-47e3-e053-5b8c7c11a4d1 のような形式です。Team キーでは Shipcue にこの ID が必要です。
Individual キーを作成する
-
プロファイルを開く
App Store Connect でユーザープロファイルを開き、Individual API Key までスクロールします。Generate API Key ボタンが表示されない場合は、チームの Admin に「Generate Individual API Keys」権限を依頼してください。
-
生成してダウンロードする
Generate API Key、続いて Download API Key をクリックします。Team キーと同じく、.p8 ファイルのダウンロードは 1 回限りです。Individual キーには Issuer ID がありません。
キーを Shipcue に追加する
-
「Add Account」を開始する
Shipcue で「Add Account」(アカウントを追加)をタップします。.p8 ファイルを「ファイル」から選ぶか、Mac から AirDrop で送って Shipcue を選ぶか、キーのテキストを貼り付けます。
-
内容を確認する
ファイル名が AuthKey_ で始まるままなら、Shipcue が Key ID を自動で入力します。Team キーの場合は Issuer ID を貼り付け、Individual キーの場合は空欄のままにします。アカウントには「Client: Acme」のような、わかりやすい名前を付けてください。
-
Shipcue に Apple で確認させる
Shipcue は、そのキーで見られるアプリを App Store Connect に問い合わせます。作成したばかりのキーは、使えるようになるまで 1、2 分かかることがあります。その間も Shipcue は再試行を続けます。
-
アプリを選ぶ
追跡するアプリを選びます。Shipcue Pro では、アプリごとに Apple に Webhook を 1 つ追加し、ステータス変更がプッシュ通知で届くようにします。Apple はアプリごとに 10 個の Webhook を許可していて、Shipcue が使うのは 1 つです。
知っておきたいこと
- 標準では、キーは Apple がエンドツーエンドで暗号化する iCloud Keychain に保存され、iPhone と iPad の両方で使えます。代わりに 1 台のデバイスだけに保存することもできます。Private モードでは、当社のサーバーにキーが届くことはありません。
- 追加する App Store Connect アカウントごとに、専用のキーが必要です。
- キーをすべての場所で止めるには、App Store Connect で失効させます。Users and Access › Integrations › App Store Connect API でキーを選び、Revoke を選びます。デバイスをなくしたときも、まずこの操作を行います(デバイスをなくしたらを参照)。
- .p8 ファイルやその内容は、当社を含め、誰にも送らないでください。
よくある質問
.p8 ファイルをもう一度ダウンロードできますか?
いいえ。Apple がダウンロードを許可するのは 1 回だけです。ファイルをなくした場合は、App Store Connect でそのキーを失効させ、新しいキーを作成してください。Shipcue では、アカウントの「Replace Key」(キーを置き換える)を使うと、アプリと設定がそのまま残ります。
Issuer ID はどこで確認できますか?
App Store Connect の Users and Access › Integrations › App Store Connect API で、Team キーの一覧の上に表示されています。Individual キーにはありません。
Developer ロールのキーは使えますか?
使えますが、ステータスの閲覧のみです。Developer のキーは Webhook を作成できないため、そのアプリではプッシュ通知が届かず、リリースや取り下げもできません。すべての機能を使うには、App Manager をお使いください。
Shipcue に Apple アカウントのパスワードは必要ですか?
いいえ。Shipcue が使うのは APIキーだけです。Apple アカウントでのサインインも、2 ファクタ認証コードも不要です。
関連ガイド
すべてのアカウントを 1 か所でフォロー
追加したすべての App Store Connect アカウントについて、App Review のステータスが変わると Shipcue がプッシュ通知を送ります。14 日間無料です。
Shipcue の仕組みを見る