Come creare una chiave API di App Store Connect
Shipcue legge lo stato di revisione e rilascia le versioni tramite l'API di App Store Connect di Apple. Per farlo ha bisogno di una chiave API per ogni account che vuoi seguire. Ecco come crearla, passo passo.
Chiave di team o chiave individuale?
App Store Connect ha due tipi di chiavi API. Shipcue funziona con entrambi.
- Chiave di team (consigliata). Creata da un Admin del team. Può vedere tutte le app del team, con il ruolo che scegli per la chiave. Include un Issuer ID.
- Chiave individuale. Creata nel tuo profilo utente. Ha lo stesso ruolo e lo stesso accesso alle app del tuo utente, quindi vede solo le app che vedi tu. Non ha un Issuer ID. Ti serve il permesso «Generate Individual API Keys», che un Admin del team può darti.
Se lavori per dei clienti, una chiave individuale è spesso la via più semplice: non serve che l'Admin crei una chiave per te, basta quel permesso.
Che ruolo deve avere la chiave?
Scegli il ruolo più limitato che fa ciò che ti serve:
- App Manager: il più adatto a Shipcue. Può rilasciare e ritirare le versioni, controllare i rilasci graduali e configurare i webhook di cui hanno bisogno le push, ma non può gestire gli utenti.
- Admin: funziona anche questo, ma può anche aggiungere e rimuovere utenti. Evitalo per una chiave che resta sul telefono.
- Developer: sola lettura. Shipcue mostra lo stato attuale quando lo apri o scorri per aggiornare, ma non può configurare le push né rilasciare o ritirare.
Crea una nuova chiave solo per Shipcue. Non riutilizzare una chiave da cui dipendono la tua CI o altri strumenti, così puoi revocarne una senza rompere l'altra.
Creare una chiave di team
-
Apri la pagina delle chiavi API
Accedi ad App Store Connect da un browser come Admin. Apri Users and Access, scegli la scheda Integrations, poi App Store Connect API nella colonna a sinistra. Se la pagina mostra un pulsante Request Access, l'Account Holder deve richiedere una volta l'accesso all'API.
-
Genera la chiave
Controlla che sia selezionato Team Keys e clicca su Generate API Key (o sul pulsante +). Dalle un nome che riconoscerai in seguito, per esempio «Shipcue». In Access scegli App Manager. Clicca su Generate.
-
Scarica il file .p8
Clicca su Download API Key accanto alla nuova chiave. Apple permette di scaricarla una sola volta e non ne conserva una copia. Il file si chiama AuthKey_ seguito dal Key ID, per esempio AuthKey_ABCD123456.p8. Conservalo in un posto sicuro, come il tuo gestore di password.
-
Copia l'Issuer ID
L'Issuer ID compare sopra l'elenco delle chiavi. Ha un aspetto simile a 69a6de8f-3c2e-47e3-e053-5b8c7c11a4d1. A Shipcue serve per una chiave di team.
Creare una chiave individuale
-
Apri il tuo profilo
In App Store Connect apri il tuo profilo utente e scorri fino a Individual API Key. Se non c'è il pulsante Generate API Key, chiedi a un Admin del team il permesso «Generate Individual API Keys».
-
Genera e scarica
Clicca su Generate API Key, poi su Download API Key. Come per le chiavi di team, il file .p8 si può scaricare una sola volta. Una chiave individuale non ha un Issuer ID.
Aggiungere la chiave a Shipcue
-
Avvia Add Account
In Shipcue tocca Add Account. Scegli il file .p8 da File, mandalo con AirDrop dal Mac e scegli Shipcue, oppure incolla il testo della chiave.
-
Controlla i dettagli
Se il file ha ancora il nome AuthKey_, Shipcue compila il Key ID al posto tuo. Incolla l'Issuer ID per una chiave di team, oppure lascialo vuoto per una chiave individuale. Dai all'account un nome che riconoscerai, come «Client: Acme».
-
Lascia che Shipcue la verifichi con Apple
Shipcue chiede ad App Store Connect quali app può vedere la chiave. Una chiave appena creata può impiegare un paio di minuti a funzionare; Shipcue continua a riprovare.
-
Scegli le tue app
Scegli le app da seguire. Con Shipcue Pro, Shipcue aggiunge un webhook per app presso Apple, così i cambi di stato ti arrivano come push. Apple consente 10 webhook per app e Shipcue ne usa 1.
Da sapere
- Per impostazione predefinita la chiave viene salvata nel tuo Portachiavi iCloud, con crittografia end-to-end di Apple, così iPhone e iPad possono usarla entrambi. Puoi invece tenere una chiave su un solo dispositivo. In modalità Private non arriva mai al nostro server.
- Ogni account App Store Connect che aggiungi richiede la propria chiave.
- Per fermare una chiave ovunque, revocala in App Store Connect: Users and Access › Integrations › App Store Connect API, seleziona la chiave, Revoke. È anche il primo passaggio se perdi un dispositivo (vedi Hai perso un dispositivo?).
- Non inviare mai il tuo file .p8 o il suo contenuto a nessuno, noi compresi.
Domande
Posso scaricare di nuovo il file .p8?
No. Apple offre il download una sola volta. Se hai perso il file, revoca quella chiave in App Store Connect e creane una nuova. In Shipcue usa Replace Key sull'account, così app e impostazioni restano.
Dove trovo l'Issuer ID?
In App Store Connect sotto Users and Access › Integrations › App Store Connect API, sopra l'elenco delle chiavi di team. Le chiavi individuali non ne hanno uno.
Posso usare una chiave con il ruolo Developer?
Sì, ma solo per vedere lo stato. Le chiavi Developer non possono creare webhook, quindi per quelle app non ci sono push, e non possono rilasciare né ritirare. Usa App Manager per avere tutto.
Shipcue ha bisogno della password del mio Account Apple?
No. Shipcue usa solo la chiave API. Non c'è nessun accesso con il tuo Account Apple e nessun codice a due fattori.
Correlati
Segui ogni account in un unico posto
Shipcue ti manda una push quando App Review cambia stato, per ogni account App Store Connect che aggiungi. Gratis per 14 giorni.
Scopri come funziona Shipcue