Configure sua chave API do App Store Connect para o Appstead

Crie a chave API com Sales and Reports, baixe o arquivo .p8 uma vez e adicione as credenciais que o Appstead precisa para um workspace ao vivo.

Um workspace ao vivo no Appstead conecta direto ao App Store Connect. Você dá ao Appstead uma chave API com o papel Sales and Reports, e o app usa ela para ler dados do app e relatórios de vendas. Não há conta Appstead nem servidor no meio.

Workspaces ao vivo fazem parte do Appstead Pro. Se quiser experimentar o app antes de conectar uma conta, o workspace demo integrado não precisa de chave.

O que você precisa

O Appstead pede quatro coisas ao adicionar um workspace ao vivo:

• Uma Issuer ID do App Store Connect
• Uma Key ID de API
• O arquivo de chave privada .p8
• Sua Vendor Number para relatórios de vendas

Antes de começar

Você precisa de uma conta Admin no App Store Connect para gerar Team Keys. Se entrar com o papel Developer ou App Manager, o botão Generate não aparece. Peça ao Admin ou Account Holder do time para criar a chave, ou para torná-lo Admin.

A chave deve ser um Team Key, não um Individual Key. A Apple não permite que Individual Keys acessem dados de Sales and Finance, então a validação de um Individual Key falha no Appstead.

Crie uma chave nova para o Appstead em vez de reutilizar uma de outra ferramenta. A chave precisa do papel Sales and Reports. Esse é o nível de acesso que o Appstead usa para configurar o workspace ao vivo.

A Apple só deixa você baixar o arquivo privado .p8 uma vez. Mantenha-o privado e à mão até importar. Nunca coloque em repositório de código nem envie por email ou chat.

1. Criar a chave API

1. Entre no App Store Connect e abra API Keys. Se navegar manualmente: em Users and Access, aba Integrations, App Store Connect API.
2. Confirme que a aba Team Keys está selecionada e escolha Generate API Key ou o botão Add (+).
3. Nomeie a chave Appstead ou outro nome que reconheça.
4. Em Access, escolha Sales and Reports.
5. Escolha Generate.

O guia de chaves API da Apple descreve o fluxo e os papéis atuais em detalhe.

2. Copiar IDs e baixar o arquivo .p8

Na página Team Keys, reúna estas três coisas:

• Issuer ID: o ID de toda a conta no topo da página. É o mesmo para cada chave da conta.
• Key ID: o ID na linha desta chave nova.
• Private Key: escolha Download API Key nessa linha para salvar o arquivo .p8.

Key ID e arquivo .p8 devem pertencer à mesma chave API. O link de download some depois de usado. Se já sumiu, crie uma chave de substituição. A Apple não guarda outra cópia do arquivo privado.

3. Encontrar a Vendor Number

O Appstead usa sua Vendor Number para solicitar relatórios de vendas. Abra Payments and Financial Reports no App Store Connect. O número aparece como Vendor # no canto superior esquerdo. É um número de toda a conta, não o Apple ID de um app.

4. Adicionar workspace ao vivo no Appstead

1. Abra o Appstead, vá em Settings e escolha Add Workspace. Se ainda não tiver workspace, a tela vazia oferece Add Live Workspace, e a Overview demo oferece Connect App Store. Os três abrem o mesmo formulário.
2. Se ainda não estiver no Appstead Pro, a tela Pro aparece primeiro. O formulário abre quando o Pro estiver ativo.
3. Dê ao workspace um nome que reconheça, por exemplo o nome do seu estúdio.
4. Cole Issuer ID e Key ID.
5. Escolha Choose .p8 File e selecione a chave privada baixada.
6. Digite a Vendor Number.
7. Escolha Validate & Save. O Appstead verifica as credenciais com a Apple antes de salvar ou importar qualquer coisa.

Se você já configurou este workspace em outro dispositivo com a mesma conta iCloud, o Appstead pode encontrar as credenciais no iCloud Keychain e oferecer continuar com elas.

O que acontece depois de conectar

• A primeira importação carrega os últimos 90 dias de relatórios de vendas diários para Overview e Trends ficarem cheios na hora. Você pode seguir usando o app enquanto importa.
• Atualizações posteriores estendem o histórico até o ano móvel de relatórios diários que a Apple fornece.
• A Apple publica o relatório de ontem normalmente por volta das 7 h horário do Pacífico. Até lá falta o dia mais recente, não é zero.
• Os últimos cinco dias são buscados de novo a cada refresh e mostrados como provisórios porque a Apple ainda pode corrigi-los.

Mais de uma conta App Store Connect

Cada workspace do Appstead guarda as credenciais de uma conta. Para uma segunda conta, por exemplo um cliente ou um time antigo, repita estes passos com uma chave nessa conta e adicione como workspace próprio. Troque de workspace com um toque.

Se o download .p8 falhar no iPhone ou iPad

O download da Apple pode falhar no iPhone ou iPad. Baixe o arquivo no Mac, transfira com AirDrop ou Arquivos e importe no Appstead. Apague cópias temporárias quando a importação funcionar.

Se o Appstead não validar a chave

Se a Apple rejeitar as credenciais, verifique nesta ordem:

• Issuer ID e Key ID não têm espaços extras.
• O arquivo .p8 escolhido pertence a essa Key ID.
• A chave é um Team Key com papel Sales and Reports e não foi revogada.
• A Vendor Number pertence à conta App Store Connect que você adiciona.

Se o Appstead disser que as credenciais funcionam mas falta um acordo, o App Store Connect aceitou a chave, mas seu Account Holder ainda precisa aceitar um acordo exigido antes de entregar relatórios de vendas. Aceite na página Agreements do App Store Connect e tente de novo.

Remover workspace ou revogar a chave

Para desconectar, abra o workspace em Settings e escolha Remove Workspace. Você pode remover só deste dispositivo, deixando nos outros, ou de todos os dispositivos.

Remover um workspace não revoga a chave na Apple. Se o arquivo .p8 vazou ou você não precisa mais, revogue a chave na página Team Keys do App Store Connect. Uma chave revogada para de funcionar no Appstead na hora. Crie uma nova antes de revogar se quiser manter o workspace.

Sua chave continua privada

O Appstead guarda a chave privada deste workspace no Keychain. O app não envia sua chave API, dados de vendas ou métricas de negócio para nenhum servidor do Appstead.