Como criar uma chave de API do App Store Connect
O Shipcue lê o status de revisão e lança versões pela API do App Store Connect da Apple. Para isso, precisa de uma chave de API de cada conta que você quer acompanhar. Veja como criar uma, passo a passo.
Chave de equipe ou chave individual?
O App Store Connect tem dois tipos de chave de API. O Shipcue funciona com os dois.
- Chave de equipe (recomendada). Criada por um Admin da equipe. Vê todos os apps da equipe, com a função escolhida para a chave. Vem com um Issuer ID.
- Chave individual. Criada no seu próprio perfil de usuário. Tem a mesma função e o mesmo acesso a apps do seu usuário, então vê apenas os apps que o seu usuário vê. Não tem Issuer ID. Você precisa da permissão "Generate Individual API Keys", que um Admin da equipe pode conceder.
Se você trabalha para clientes, a chave individual costuma ser o caminho mais fácil: você não precisa que o Admin crie uma chave, só que conceda essa permissão.
Qual função a chave deve ter?
Escolha a função mais limitada que atenda ao que você precisa:
- 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 gerenciar usuários.
- Admin: também funciona, mas pode adicionar e remover usuários. Evite-o para uma chave que fica no celular.
- Developer: somente visualização. O Shipcue mostra o status atual ao abrir ou ao puxar para atualizar, mas não consegue configurar 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 quebrar a outra.
Criar uma chave de equipe
-
Abra a página de chaves de API
Entre no App Store Connect por um navegador como Admin. Abra Users and Access, escolha a aba Integrations e depois App Store Connect API na coluna da esquerda. Se a página mostrar um botão Request Access, o Account Holder precisa solicitar 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ê um nome que ajude a reconhecê-la depois, por exemplo "Shipcue". Em Access, escolha App Manager. Clique em Generate.
-
Baixe o arquivo .p8
Clique em Download API Key ao lado da chave nova. A Apple só permite baixar uma vez e não guarda uma cópia. O arquivo se chama AuthKey_ seguido do Key ID, por exemplo AuthKey_ABCD123456.p8. Guarde-o em um lugar seguro, como o seu gerenciador de senhas.
-
Copie o Issuer ID
O Issuer ID aparece acima da lista de chaves. Ele se parece com 69a6de8f-3c2e-47e3-e053-5b8c7c11a4d1. O Shipcue precisa dele para uma chave de equipe.
Criar uma chave individual
-
Abra o seu perfil
No App Store Connect, abra o seu perfil de usuário e desça até Individual API Key. Se não houver um botão Generate API Key, peça a um Admin da equipe a permissão "Generate Individual API Keys".
-
Gere e baixe
Clique em Generate API Key e depois em Download API Key. Como nas chaves de equipe, o arquivo .p8 só pode ser baixado uma vez. Uma chave individual não tem Issuer ID.
Adicione a chave ao Shipcue
-
Comece por Add Account
No Shipcue, toque em Add Account. Escolha o arquivo .p8 no app Arquivos, envie-o do Mac por AirDrop e escolha o Shipcue, ou cole o texto da chave.
-
Verifique os detalhes
Se o arquivo ainda tiver o nome AuthKey_, o Shipcue preenche o Key ID automaticamente. Cole o Issuer ID para uma chave de equipe ou deixe vazio para uma 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 quais apps a chave consegue ver. Uma chave recém-criada pode levar um ou dois minutos para começar a funcionar; o Shipcue tenta de novo até funcionar.
-
Escolha os apps
Escolha os apps a acompanhar. Com o Shipcue Pro, o Shipcue adiciona um webhook por app na Apple para que as mudanças de status cheguem por push. A Apple permite 10 webhooks por app, e o Shipcue usa 1.
Bom saber
- Por padrão, a chave é salva nas suas Chaves do iCloud, com criptografia de ponta a ponta da Apple, para que o iPhone e o iPad possam usá-la. Se preferir, você pode manter a chave em um único dispositivo. No modo Private, ela nunca chega ao nosso servidor.
- Cada conta do App Store Connect que você adicionar precisa da sua própria chave.
- Para fazer uma chave parar de funcionar em todos os lugares, revogue-a no App Store Connect: Users and Access › Integrations › App Store Connect API, selecione a chave, Revoke. Esse também é o primeiro passo se você perder um dispositivo (veja Perdeu um dispositivo?).
- Nunca envie o arquivo .p8 nem o conteúdo dele a ninguém, nem a nós.
Perguntas
Posso baixar o arquivo .p8 de novo?
Não. A Apple oferece o download uma única vez. Se você perdeu o arquivo, revogue essa chave no App Store Connect e crie uma nova. No Shipcue, use Replace Key na conta para manter os apps e as configuraçõ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 equipe. Chaves individuais não têm um.
Posso usar uma chave com a função Developer?
Sim, mas só para ver o status. Chaves Developer não criam webhooks, então esses apps não têm push, e elas não podem lançar nem retirar. Use App Manager para ter tudo.
O Shipcue precisa da senha da minha Conta Apple?
Não. O Shipcue usa apenas a chave de API. Não há acesso com a Conta Apple nem código de dois fatores.
Relacionados
Acompanhe todas as contas em um só lugar
O Shipcue envia um push quando o App Review muda de status, em cada conta do App Store Connect que você adicionar. Grátis por 14 dias.
Veja como o Shipcue funciona