So erstellst du einen App Store Connect API-Schlüssel
Shipcue liest den Prüfstatus und veröffentlicht Versionen über Apples App Store Connect API. Dafür braucht es von jedem Account, dem du folgen willst, einen API-Schlüssel. Hier erfährst du Schritt für Schritt, wie du ihn erstellst.
Team-Schlüssel oder Individual-Schlüssel?
App Store Connect kennt zwei Arten von API-Schlüsseln. Shipcue funktioniert mit beiden.
- Team-Schlüssel (empfohlen). Wird von einem Admin des Teams erstellt. Er sieht alle Apps des Teams, mit der Rolle, die du für den Schlüssel wählst. Er kommt mit einer Issuer ID.
- Individual-Schlüssel. Wird in deinem eigenen Benutzerprofil erstellt. Er hat dieselbe Rolle und denselben App-Zugriff wie dein Benutzer und sieht nur die Apps, die du siehst. Er hat keine Issuer ID. Du brauchst die Berechtigung „Generate Individual API Keys“, die dir ein Team-Admin geben kann.
Wenn du für Kunden arbeitest, ist ein Individual-Schlüssel oft der einfachere Weg: Der Admin muss dir keinen Schlüssel erstellen, sondern nur diese Berechtigung geben.
Welche Rolle sollte der Schlüssel haben?
Wähle die kleinste Rolle, die das Nötige kann:
- App Manager: die beste Wahl für Shipcue. Die Rolle kann Versionen veröffentlichen und zurückziehen, gestaffelte Veröffentlichungen steuern und die Webhooks einrichten, die Push braucht, aber keine Nutzer verwalten.
- Admin: funktioniert auch, kann aber zusätzlich Nutzer hinzufügen und entfernen. Meide die Rolle für einen Schlüssel, der auf deinem Handy liegt.
- Developer: nur ansehen. Shipcue zeigt den aktuellen Status, wenn du die App öffnest oder durch Ziehen aktualisierst, kann aber weder Push einrichten noch veröffentlichen oder zurückziehen.
Erstelle einen neuen Schlüssel nur für Shipcue. Verwende keinen Schlüssel weiter, von dem dein CI oder andere Tools abhängen, damit du den einen widerrufen kannst, ohne den anderen zu stören.
Team-Schlüssel erstellen
-
Seite mit den API-Schlüsseln öffnen
Melde dich im Browser als Admin bei App Store Connect an. Öffne Users and Access, wähle den Tab Integrations und dann App Store Connect API in der linken Spalte. Wenn die Seite einen Button Request Access zeigt, muss der Account Holder den API-Zugriff einmalig beantragen.
-
Schlüssel erzeugen
Stelle sicher, dass Team Keys ausgewählt ist, und klicke auf Generate API Key (oder auf den +-Button). Gib ihm einen Namen, den du später wiedererkennst, zum Beispiel „Shipcue“. Wähle unter Access die Rolle App Manager. Klicke auf Generate.
-
.p8-Datei herunterladen
Klicke neben dem neuen Schlüssel auf Download API Key. Apple erlaubt den Download nur einmal und behält keine Kopie. Die Datei heißt AuthKey_ gefolgt von der Key ID, zum Beispiel AuthKey_ABCD123456.p8. Bewahre sie sicher auf, etwa in deinem Passwortmanager.
-
Issuer ID kopieren
Die Issuer ID steht oberhalb der Schlüsselliste. Sie sieht so aus: 69a6de8f-3c2e-47e3-e053-5b8c7c11a4d1. Shipcue braucht sie für einen Team-Schlüssel.
Individual-Schlüssel erstellen
-
Dein Profil öffnen
Öffne in App Store Connect dein Benutzerprofil und scrolle nach unten zu Individual API Key. Wenn es keinen Button Generate API Key gibt, bitte einen Team-Admin um die Berechtigung „Generate Individual API Keys“.
-
Erzeugen und herunterladen
Klicke auf Generate API Key und dann auf Download API Key. Wie bei Team-Schlüsseln lässt sich die .p8-Datei nur einmal herunterladen. Ein Individual-Schlüssel hat keine Issuer ID.
Schlüssel zu Shipcue hinzufügen
-
Add Account starten
Tippe in Shipcue auf Add Account. Wähle die .p8-Datei in Dateien, schick sie per AirDrop vom Mac und wähle Shipcue, oder füge den Schlüsseltext ein.
-
Angaben prüfen
Wenn die Datei noch ihren AuthKey_-Namen trägt, trägt Shipcue die Key ID für dich ein. Füge bei einem Team-Schlüssel die Issuer ID ein oder lass das Feld bei einem Individual-Schlüssel leer. Gib dem Account einen Namen, den du wiedererkennst, etwa „Client: Acme“.
-
Shipcue bei Apple prüfen lassen
Shipcue fragt App Store Connect, welche Apps der Schlüssel sehen kann. Ein ganz neuer Schlüssel braucht manchmal ein, zwei Minuten, bis er funktioniert; Shipcue versucht es weiter.
-
Apps auswählen
Wähle die Apps, denen du folgen willst. Mit Shipcue Pro legt Shipcue pro App einen Webhook bei Apple an, damit Statusänderungen als Push bei dir ankommen. Apple erlaubt 10 Webhooks pro App, Shipcue nutzt 1.
Gut zu wissen
- Standardmäßig wird der Schlüssel in deiner iCloud Keychain gespeichert, von Apple Ende-zu-Ende-verschlüsselt, damit iPhone und iPad ihn beide nutzen können. Du kannst einen Schlüssel stattdessen nur auf einem Gerät behalten. Im Private-Modus erreicht er nie unseren Server.
- Jeder App Store Connect Account, den du hinzufügst, braucht einen eigenen Schlüssel.
- Um einen Schlüssel überall zu stoppen, widerrufe ihn in App Store Connect: Users and Access › Integrations › App Store Connect API, Schlüssel auswählen, Revoke. Das ist auch der erste Schritt, wenn du ein Gerät verlierst (siehe Gerät verloren?).
- Schick deine .p8-Datei oder ihren Inhalt nie an jemanden, auch nicht an uns.
Fragen
Kann ich die .p8-Datei noch einmal herunterladen?
Nein. Apple bietet den Download nur einmal an. Wenn du die Datei verloren hast, widerrufe den Schlüssel in App Store Connect und erstelle einen neuen. Nutze in Shipcue beim Account Replace Key, damit seine Apps und Einstellungen erhalten bleiben.
Wo finde ich die Issuer ID?
In App Store Connect unter Users and Access › Integrations › App Store Connect API, oberhalb der Liste der Team-Schlüssel. Individual-Schlüssel haben keine.
Kann ich einen Schlüssel mit der Rolle Developer nutzen?
Ja, aber nur, um den Status zu sehen. Developer-Schlüssel können keine Webhooks anlegen, daher gibt es für diese Apps keinen Push, und sie können weder veröffentlichen noch zurückziehen. Nutze App Manager für den vollen Umfang.
Braucht Shipcue das Passwort meines Apple Accounts?
Nein. Shipcue nutzt nur den API-Schlüssel. Es gibt keine Anmeldung mit deinem Apple Account und keinen Zwei-Faktor-Code.
Verwandte Themen
Alle Accounts an einem Ort im Blick
Shipcue schickt dir einen Push, wenn sich der App-Review-Status ändert, für jeden App Store Connect Account, den du hinzufügst. 14 Tage kostenlos.
So funktioniert Shipcue