如何建立 App Store Connect API 金鑰
Shipcue 透過 Apple 的 App Store Connect API 讀取審查狀態並發佈版本。為此,它需要你要追蹤的每個帳號各提供一組 API 金鑰。以下一步步告訴你怎麼建立。
Team 金鑰還是 Individual 金鑰?
App Store Connect 有兩種 API 金鑰,Shipcue 都支援。
- Team 金鑰(建議)。由團隊的 Admin 建立。它可以看到團隊的所有 App,權限取決於你為金鑰選擇的角色,並附帶一個 Issuer ID。
- Individual 金鑰。在你自己的使用者資料中建立。它的角色和 App 存取範圍與你的使用者相同,所以只能看到你能看到的 App。它沒有 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。Apple 只允許下載一次,也不會保留副本。檔名以 AuthKey_ 開頭,後面是 Key ID,例如 AuthKey_ABCD123456.p8。請把它保存在安全的地方,例如你的密碼管理工具。
-
複製 Issuer ID
Issuer ID 顯示在金鑰清單的上方,形如 69a6de8f-3c2e-47e3-e053-5b8c7c11a4d1。Team 金鑰需要在 Shipcue 中填寫它。
建立 Individual 金鑰
-
開啟你的個人資料
在 App Store Connect 中開啟你的使用者資料,向下捲動到 Individual API Key。如果沒有 Generate API Key 按鈕,請向團隊 Admin 申請「Generate Individual API Keys」權限。
-
產生並下載
點 Generate API Key,再點 Download API Key。和 Team 金鑰一樣,.p8 檔案只能下載一次。Individual 金鑰沒有 Issuer ID。
把金鑰加入 Shipcue
-
開始 Add Account
在 Shipcue 中點一下 Add Account。從「檔案」App 選擇 .p8 檔案,或從 Mac 用 AirDrop 傳送並選擇 Shipcue,也可以貼上金鑰文字。
-
核對資訊
如果檔案仍保留 AuthKey_ 的名稱,Shipcue 會自動填好 Key ID。Team 金鑰需要貼上 Issuer ID,Individual 金鑰則留空。幫帳號取一個你認得出來的名稱,例如「Client: Acme」。
-
讓 Shipcue 向 Apple 驗證
Shipcue 會向 App Store Connect 詢問這組金鑰能看到哪些 App。剛建立的金鑰可能要過一兩分鐘才會生效,Shipcue 會持續重試。
-
選擇你的 App
選擇要追蹤的 App。使用 Shipcue Pro 時,Shipcue 會為每個 App 在 Apple 那裡新增一個 webhook,讓狀態變更以推播的形式送達你。Apple 允許每個 App 最多 10 個 webhook,Shipcue 用 1 個。
補充說明
- 預設情況下,金鑰保存在你的 iCloud Keychain 中,由 Apple 端對端加密,這樣你的 iPhone 和 iPad 都能使用。你也可以選擇只把金鑰保存在一部裝置上。在 Private 模式下,它不會傳到我們的伺服器。
- 你加入的每個 App Store Connect 帳號都需要自己的金鑰。
- 要讓金鑰在所有地方失效,請在 App Store Connect 中撤銷:Users and Access › Integrations › App Store Connect API,選取金鑰,點 Revoke。如果你遺失了裝置,這也是第一步(見裝置遺失了?)。
- 請勿把 .p8 檔案或其內容寄給任何人,包括我們。
常見問題
可以再次下載 .p8 檔案嗎?
不可以。Apple 只提供一次下載。如果檔案遺失了,請在 App Store Connect 中撤銷該金鑰並建立新的。在 Shipcue 中,對該帳號使用 Replace Key,這樣它的 App 和設定都會保留。
Issuer ID 在哪裡找?
在 App Store Connect 的 Users and Access › Integrations › App Store Connect API 中,位於 Team 金鑰清單的上方。Individual 金鑰沒有 Issuer ID。
可以使用 Developer 角色的金鑰嗎?
可以,但只能檢視狀態。Developer 金鑰無法建立 webhook,所以這些 App 沒有推播,也無法發佈或撤回。要使用全部功能,請用 App Manager。
Shipcue 需要我的 Apple 帳號密碼嗎?
不需要。Shipcue 只使用 API 金鑰。不需要用你的 Apple 帳號登入,也不需要雙重認證碼。
相關內容
在同一個地方追蹤所有帳號
App Review 狀態變更時,Shipcue 會發送推播,涵蓋你加入的每個 App Store Connect 帳號。免費試用 14 天。
了解 Shipcue 如何運作