Como criar uma chave de API do App Store Connect
O Shipcue lê o estado de revisão e lança versões através da API do App Store Connect da Apple. Para isso, precisa de uma chave de API de cada conta que quer acompanhar. Veja como criar uma, passo a passo.
Chave de equipa ou chave individual?
O App Store Connect tem dois tipos de chave de API. O Shipcue funciona com os dois.
- Chave de equipa (recomendada). Criada por um Admin da equipa. Vê todas as apps da equipa, com a função escolhida para a chave. Vem com um Issuer ID.
- Chave individual. Criada no seu próprio perfil de utilizador. Tem a mesma função e o mesmo acesso a apps que o seu utilizador, pelo que só vê as apps que o seu utilizador vê. Não tem Issuer ID. É preciso ter a permissão "Generate Individual API Keys", que um Admin da equipa pode conceder.
Para quem trabalha com clientes, a chave individual costuma ser o caminho mais fácil: o Admin não tem de criar uma chave, só de conceder essa permissão.
Que função deve ter a chave?
Escolha a função mais restrita que cubra a necessidade:
- App Manager: a melhor opção para o Shipcue. Pode lançar e retirar versões, controlar lançamentos em fases e configurar os webhooks de que o push precisa, mas não pode gerir utilizadores.
- Admin: também funciona, mas pode adicionar e remover utilizadores. Evite-a numa chave que fica no telemóvel.
- Developer: só de visualização. O Shipcue mostra o estado atual ao abrir ou ao puxar para atualizar, mas não consegue configurar o push nem lançar ou retirar.
Crie uma chave nova só para o Shipcue. Não reutilize uma chave de que o seu CI ou outras ferramentas dependam, para poder revogar uma sem afetar a outra.
Criar uma chave de equipa
-
Abra a página de chaves de API
Inicie sessão no App Store Connect num navegador como Admin. Abra Users and Access, escolha o separador Integrations e depois App Store Connect API na coluna da esquerda. Se a página mostrar um botão Request Access, o Account Holder tem de pedir o acesso à API uma vez.
-
Gere a chave
Confirme que Team Keys está selecionado e clique em Generate API Key (ou no botão +). Dê-lhe um nome que ajude a reconhecê-la mais tarde, por exemplo "Shipcue". Em Access, escolha App Manager. Clique em Generate.
-
Transfira o ficheiro .p8
Clique em Download API Key ao lado da chave nova. A Apple só permite transferi-la uma vez e não guarda uma cópia. O ficheiro chama-se AuthKey_ seguido do Key ID, por exemplo AuthKey_ABCD123456.p8. Guarde-o num local seguro, como o seu gestor de palavras-passe.
-
Copie o Issuer ID
O Issuer ID aparece acima da lista de chaves. Tem este aspeto: 69a6de8f-3c2e-47e3-e053-5b8c7c11a4d1. O Shipcue precisa dele para uma chave de equipa.
Criar uma chave individual
-
Abra o seu perfil
No App Store Connect, abra o seu perfil de utilizador e desloque-se até Individual API Key. Se não houver um botão Generate API Key, peça a um Admin da equipa a permissão "Generate Individual API Keys".
-
Gere e transfira
Clique em Generate API Key e depois em Download API Key. Como nas chaves de equipa, o ficheiro .p8 só pode ser transferido uma vez. Uma chave individual não tem Issuer ID.
Adicione a chave ao Shipcue
-
Inicie o Add Account
No Shipcue, toque em Add Account. Escolha o ficheiro .p8 na app Ficheiros, envie-o do Mac por AirDrop e escolha o Shipcue, ou cole o texto da chave.
-
Verifique os detalhes
Se o ficheiro ainda tiver o nome AuthKey_, o Shipcue preenche o Key ID automaticamente. Cole o Issuer ID numa chave de equipa ou deixe-o vazio numa chave individual. Dê à conta um nome fácil de reconhecer, como "Cliente: Acme".
-
Deixe o Shipcue verificar com a Apple
O Shipcue pergunta ao App Store Connect que apps a chave consegue ver. Uma chave acabada de criar pode demorar um ou dois minutos a começar a funcionar; o Shipcue volta a tentar até conseguir.
-
Escolha as apps
Escolha as apps que quer acompanhar. Com o Shipcue Pro, o Shipcue adiciona um webhook por app na Apple para que as mudanças de estado cheguem por push. A Apple permite 10 webhooks por app, e o Shipcue usa 1.
Bom saber
- Por predefinição, a chave é guardada no seu iCloud Keychain, com encriptação de ponta a ponta da Apple, para que o iPhone e o iPad a possam usar. Em alternativa, pode manter a chave num único dispositivo. No modo Private, a chave nunca chega ao nosso servidor.
- Cada conta do App Store Connect adicionada precisa da sua própria chave.
- Para que uma chave deixe de funcionar em todo o lado, revogue-a no App Store Connect: Users and Access › Integrations › App Store Connect API, selecione a chave, Revoke. Este é também o primeiro passo se perder um dispositivo (veja Perdeu um dispositivo?).
- Nunca envie o ficheiro .p8 nem o seu conteúdo a ninguém, nem sequer a nós.
Perguntas
Posso voltar a transferir o ficheiro .p8?
Não. A Apple só permite a transferência uma vez. Se perdeu o ficheiro, revogue essa chave no App Store Connect e crie uma nova. No Shipcue, use Replace Key na conta para manter as apps e as definições.
Onde encontro o Issuer ID?
No App Store Connect, em Users and Access › Integrations › App Store Connect API, acima da lista de chaves de equipa. Chaves individuais não têm um.
Posso usar uma chave com a função Developer?
Sim, mas só para ver o estado. As chaves Developer não criam webhooks, pelo que essas apps não têm push, e também não podem lançar nem retirar. Use App Manager para ter tudo.
O Shipcue precisa da palavra-passe da minha Conta Apple?
Não. O Shipcue usa apenas a chave de API. Não há início de sessão com a Conta Apple nem códigos de dois fatores.
Relacionados
Acompanhe todas as contas num só lugar
O Shipcue envia-lhe um push quando o App Review muda de estado, em cada conta do App Store Connect adicionada. Grátis durante 14 dias.
Veja como o Shipcue funciona