Jak utworzyć klucz API App Store Connect
Shipcue odczytuje status weryfikacji i wydaje wersje przez API App Store Connect od Apple. Do tego potrzebuje klucza API z każdego konta, które chcesz śledzić. Oto jak go zrobić, krok po kroku.
Klucz Team czy Individual?
App Store Connect ma dwa rodzaje kluczy API. Shipcue działa z obydwoma.
- Klucz Team (zalecany). Tworzy go Admin zespołu. Widzi wszystkie aplikacje zespołu, z rolą wybraną dla klucza. Ma Issuer ID.
- Klucz Individual. Tworzony we własnym profilu użytkownika. Ma taką samą rolę i dostęp do aplikacji jak twój użytkownik, więc widzi tylko aplikacje, które ty widzisz. Nie ma Issuer ID. Potrzebujesz uprawnienia „Generate Individual API Keys”, które może ci nadać Admin zespołu.
Jeśli pracujesz dla klientów, klucz Individual to często łatwiejsza droga: nie musisz prosić Admina o utworzenie klucza, wystarczy samo uprawnienie.
Jaką rolę powinien mieć klucz?
Wybierz najmniejszą rolę, która robi to, czego potrzebujesz:
- App Manager: najlepszy wybór dla Shipcue. Może wydawać i wycofywać wersje, sterować wydaniami etapowymi i ustawiać webhooki potrzebne do push, ale nie zarządza użytkownikami.
- Admin: też działa, ale może dodatkowo dodawać i usuwać użytkowników. Unikaj go dla klucza, który leży w telefonie.
- Developer: tylko podgląd. Shipcue pokazuje aktualny status po otwarciu lub odświeżeniu pociągnięciem, ale nie skonfiguruje push i nie wyda ani nie wycofa wersji.
Zrób nowy klucz tylko dla Shipcue. Nie używaj ponownie klucza, od którego zależą twoje CI lub inne narzędzia, żeby można było unieważnić jeden bez psucia drugiego.
Utwórz klucz Team
-
Otwórz stronę kluczy API
Zaloguj się do App Store Connect w przeglądarce jako Admin. Otwórz Users and Access, wybierz kartę Integrations, a potem App Store Connect API w lewej kolumnie. Jeśli strona pokazuje przycisk Request Access, Account Holder musi jednorazowo zażądać dostępu do API.
-
Wygeneruj klucz
Upewnij się, że wybrane jest Team Keys, i kliknij Generate API Key (lub przycisk +). Nazwij go tak, by łatwo go później rozpoznać, np. „Shipcue”. W polu Access wybierz App Manager. Kliknij Generate.
-
Pobierz plik .p8
Kliknij Download API Key przy nowym kluczu. Apple pozwala pobrać go tylko raz i nie zachowuje kopii. Plik nazywa się AuthKey_ z dopiskiem Key ID, na przykład AuthKey_ABCD123456.p8. Trzymaj go w bezpiecznym miejscu, np. w menedżerze haseł.
-
Skopiuj Issuer ID
Issuer ID jest widoczny nad listą kluczy. Wygląda tak: 69a6de8f-3c2e-47e3-e053-5b8c7c11a4d1. Shipcue potrzebuje go dla klucza Team.
Utwórz klucz Individual
-
Otwórz swój profil
W App Store Connect otwórz swój profil użytkownika i przewiń do Individual API Key. Jeśli nie ma przycisku Generate API Key, poproś Admina zespołu o uprawnienie „Generate Individual API Keys”.
-
Wygeneruj i pobierz
Kliknij Generate API Key, a potem Download API Key. Tak jak w kluczach Team, plik .p8 można pobrać tylko raz. Klucz Individual nie ma Issuer ID.
Dodaj klucz do Shipcue
-
Zacznij od Add Account
W Shipcue dotknij Add Account. Wybierz plik .p8 z aplikacji Pliki, wyślij go AirDropem z Maca i wybierz Shipcue albo wklej tekst klucza.
-
Sprawdź dane
Jeśli plik nadal ma nazwę AuthKey_, Shipcue uzupełni Key ID za ciebie. Wklej Issuer ID dla klucza Team albo zostaw puste dla klucza Individual. Nadaj kontu nazwę, którą rozpoznasz, np. „Client: Acme”.
-
Niech Shipcue sprawdzi go u Apple
Shipcue pyta App Store Connect, które aplikacje widzi klucz. Całkiem nowy klucz może zacząć działać dopiero po minucie lub dwóch; Shipcue ponawia próby.
-
Wybierz aplikacje
Wybierz aplikacje do śledzenia. Z Shipcue Pro aplikacja dodaje jeden webhook na aplikację u Apple, żeby zmiany statusu docierały do ciebie jako push. Apple dopuszcza 10 webhooków na aplikację, a Shipcue używa 1.
Warto wiedzieć
- Domyślnie klucz jest zapisywany w twoim iCloud Keychain, szyfrowanym przez Apple end-to-end, żeby iPhone i iPad mogły go używać. Możesz zamiast tego trzymać klucz tylko na jednym urządzeniu. W trybie Private nigdy nie trafia na nasz serwer.
- Każde dodane konto App Store Connect wymaga własnego klucza.
- Aby zatrzymać klucz wszędzie, unieważnij go w App Store Connect: Users and Access › Integrations › App Store Connect API, wybierz klucz, Revoke. To także pierwszy krok, gdy zgubisz urządzenie (zob. Zgubione urządzenie?).
- Nigdy nie wysyłaj nikomu pliku .p8 ani jego zawartości, także nam.
Pytania
Czy mogę pobrać plik .p8 ponownie?
Nie. Apple oferuje pobranie tylko raz. Jeśli zgubisz plik, unieważnij ten klucz w App Store Connect i utwórz nowy. W Shipcue użyj Replace Key na koncie, żeby zachować jego aplikacje i ustawienia.
Gdzie znajdę Issuer ID?
W App Store Connect w Users and Access › Integrations › App Store Connect API, nad listą kluczy Team. Klucze Individual go nie mają.
Czy mogę użyć klucza z rolą Developer?
Tak, ale tylko do podglądu statusu. Klucze Developer nie mogą tworzyć webhooków, więc te aplikacje nie dostaną push, i nie mogą wydawać ani wycofywać wersji. Do pełnej funkcjonalności użyj App Manager.
Czy Shipcue potrzebuje hasła do mojego konta Apple?
Nie. Shipcue używa wyłącznie klucza API. Nie ma logowania kontem Apple ani kodu dwuskładnikowego.
Powiązane
Śledź każde konto w jednym miejscu
Shipcue wysyła push, gdy zmienia się status App Review, dla każdego dodanego konta App Store Connect. Bezpłatnie przez 14 dni.
Zobacz, jak działa Shipcue