Comment créer une clé API App Store Connect
Shipcue lit le statut de revue et publie les versions via l’API App Store Connect d’Apple. Pour cela, il lui faut une clé API de chaque compte que vous voulez suivre. Voici comment en créer une, pas à pas.
Clé Team ou clé Individual ?
App Store Connect propose deux types de clés API. Shipcue fonctionne avec les deux.
- Clé Team (recommandée). Créée par un Admin de l’équipe. Elle voit toutes les apps de l’équipe, avec le rôle que vous choisissez pour la clé. Elle s’accompagne d’un Issuer ID.
- Clé Individual. Créée dans votre propre profil utilisateur. Elle a le même rôle et le même accès aux apps que votre utilisateur, donc elle ne voit que les apps que vous voyez. Elle n’a pas d’Issuer ID. Il vous faut l’autorisation « Generate Individual API Keys », qu’un Admin de l’équipe peut vous accorder.
Si vous travaillez pour des clients, une clé Individual est souvent plus simple : pas besoin que l’Admin vous crée une clé, juste cette autorisation.
Quel rôle donner à la clé ?
Choisissez le plus petit rôle qui fait ce dont vous avez besoin :
- App Manager : le meilleur choix pour Shipcue. Il peut publier et retirer des versions, contrôler les publications progressives et configurer les webhooks dont le push a besoin, mais il ne peut pas gérer les utilisateurs.
- Admin : fonctionne aussi, mais peut en plus ajouter et supprimer des utilisateurs. À éviter pour une clé qui vit sur votre téléphone.
- Developer : lecture seule. Shipcue affiche le statut actuel quand vous l’ouvrez ou tirez pour rafraîchir, mais ne peut ni configurer le push, ni publier, ni retirer.
Créez une nouvelle clé réservée à Shipcue. Ne réutilisez pas une clé dont dépendent votre CI ou d’autres outils, pour pouvoir en révoquer une sans casser l’autre.
Créer une clé Team
-
Ouvrir la page des clés API
Connectez-vous à App Store Connect dans un navigateur en tant qu’Admin. Ouvrez Users and Access, choisissez l’onglet Integrations, puis App Store Connect API dans la colonne de gauche. Si la page affiche un bouton Request Access, l’Account Holder doit demander l’accès à l’API une fois.
-
Générer la clé
Vérifiez que Team Keys est sélectionné et cliquez sur Generate API Key (ou sur le bouton +). Donnez-lui un nom que vous reconnaîtrez, par exemple « Shipcue ». Sous Access, choisissez App Manager. Cliquez sur Generate.
-
Télécharger le fichier .p8
Cliquez sur Download API Key à côté de la nouvelle clé. Apple ne permet de la télécharger qu’une seule fois et n’en garde pas de copie. Le fichier s’appelle AuthKey_ suivi du Key ID, par exemple AuthKey_ABCD123456.p8. Conservez-le en lieu sûr, par exemple dans votre gestionnaire de mots de passe.
-
Copier l’Issuer ID
L’Issuer ID s’affiche au-dessus de la liste des clés. Il ressemble à 69a6de8f-3c2e-47e3-e053-5b8c7c11a4d1. Shipcue en a besoin pour une clé Team.
Créer une clé Individual
-
Ouvrir votre profil
Dans App Store Connect, ouvrez votre profil utilisateur et faites défiler jusqu’à Individual API Key. S’il n’y a pas de bouton Generate API Key, demandez à un Admin de l’équipe l’autorisation « Generate Individual API Keys ».
-
Générer et télécharger
Cliquez sur Generate API Key, puis sur Download API Key. Comme pour les clés Team, le fichier .p8 ne peut être téléchargé qu’une seule fois. Une clé Individual n’a pas d’Issuer ID.
Ajouter la clé à Shipcue
-
Lancer Add Account
Dans Shipcue, touchez Add Account. Choisissez le fichier .p8 dans Fichiers, envoyez-le par AirDrop depuis votre Mac et choisissez Shipcue, ou collez le texte de la clé.
-
Vérifier les informations
Si le fichier porte encore son nom AuthKey_, Shipcue renseigne le Key ID pour vous. Collez l’Issuer ID pour une clé Team, ou laissez-le vide pour une clé Individual. Donnez au compte un nom que vous reconnaîtrez, comme « Client: Acme ».
-
Laisser Shipcue vérifier auprès d’Apple
Shipcue demande à App Store Connect quelles apps la clé peut voir. Une clé toute neuve peut mettre une minute ou deux à fonctionner ; Shipcue continue d’essayer.
-
Choisir vos apps
Choisissez les apps à suivre. Avec Shipcue Pro, Shipcue ajoute un webhook par app chez Apple pour que les changements de statut vous parviennent en push. Apple autorise 10 webhooks par app, et Shipcue en utilise 1.
Bon à savoir
- Par défaut, la clé est enregistrée dans votre trousseau iCloud, chiffré de bout en bout par Apple, pour que votre iPhone et votre iPad puissent tous deux l’utiliser. Vous pouvez plutôt la garder sur un seul appareil. En mode Private, elle n’atteint jamais notre serveur.
- Chaque compte App Store Connect que vous ajoutez nécessite sa propre clé.
- Pour arrêter une clé partout, révoquez-la dans App Store Connect : Users and Access › Integrations › App Store Connect API, sélectionnez la clé, Revoke. C’est aussi la première étape si vous perdez un appareil (voir Appareil perdu ?).
- N’envoyez jamais votre fichier .p8 ni son contenu à personne, nous y compris.
Questions
Puis-je télécharger à nouveau le fichier .p8 ?
Non. Apple ne propose le téléchargement qu’une seule fois. Si vous avez perdu le fichier, révoquez cette clé dans App Store Connect et créez-en une nouvelle. Dans Shipcue, utilisez Replace Key sur le compte pour conserver ses apps et ses réglages.
Où trouver l’Issuer ID ?
Dans App Store Connect, sous Users and Access › Integrations › App Store Connect API, au-dessus de la liste des clés Team. Les clés Individual n’en ont pas.
Puis-je utiliser une clé avec le rôle Developer ?
Oui, mais seulement pour voir les statuts. Les clés Developer ne peuvent pas créer de webhooks : il n’y a donc pas de push pour ces apps, et elles ne peuvent ni publier ni retirer. Utilisez App Manager pour disposer de tout.
Shipcue a-t-il besoin du mot de passe de mon compte Apple ?
Non. Shipcue n’utilise que la clé API. Il n’y a ni connexion avec votre compte Apple, ni code à deux facteurs.
À lire aussi
Suivez tous vos comptes au même endroit
Shipcue envoie un push quand App Review change de statut, pour chaque compte App Store Connect que vous ajoutez. Gratuit pendant 14 jours.
Voir comment fonctionne Shipcue