Automatize seu processo de desenvolvimento com a API do App Store Connect

Olá. Meu nome é Dajinsol Jeon. Sou engineer na equipe App Store Connect. Hoje, vou apresentar as atualizações da API App Store Connect. Vamos lá.

O App Store Connect fornece APIs para automatizar processos de desenvolvimento. Essa automação permite que sua equipe foque no que mais importa: Criar recursos incríveis para os usuários. Neste ano, o App Store Connect expandiu sua API para áreas importantes, como gerenciamento de apps e TestFlight. E ele oferece suporte a novos conjuntos de APIs, que incluem as tão esperadas APIs Webhooks e Apple-Hosted Background Assets. Hoje, falarei sobre as atualizações importantes e muito aguardadas, como as APIs Webhooks, BuildUpload e Feedback. Antes, vou relembrar o processo típico de desenvolvimento de apps. Trata-se de um processo iterativo. Você cria recursos ou corrige erros e faz upload de uma compilação no App Store Connect. Após a distribuição da compilação, os testers beta enviam feedback e a próxima fase de desenvolvimento incorpora o feedback anterior. O segredo é executar esse ciclo o mais rápido possível. Quando os usuários relatarem uma falha, corrija-a o quanto antes para melhorar a experiência deles. É aí que entram as atualizações de hoje. As novas APIs App Store Connect permitem automatizar esse loop, acelerando a iteração. Vamos ver como. Neste ano, o App Store Connect lançou as APIs Build Upload e Feedback para melhorar a automação. Além disso, ele agora oferece suporte a notificações webhook. Seu sistema pode ser notificado quando algo acontecer no app e reagir a esses eventos. O App Store Connect enviará um evento Build upload state ao ouvinte de webhook quando o processamento da compilação carregada for concluído. Isso sinaliza que você pode prosseguir. As notificações webhook permitem mais eventos, como Feedback e Build beta state, para informar eventos importantes sobre seu app. Essas adições ajudarão a agilizar seu ciclo de desenvolvimento. Vamos explorar essas melhorias com mais detalhes. Começarei pelas notificações webhook. APIs tradicionais são como ligar para alguém e perguntar: “Novidades?”. Seu sistema precisa pedir atualizações ao App Store Connect, mas os webhooks acabam com isso. Eles são basicamente comunicação por push entre servidores. Em vez de seu sistema perguntar, o App Store Connect envia notificações sobre os eventos. É um callback HTTP do App Store Connect para o servidor quando ocorre um evento especificado relacionado ao app.

Isso permite criar fluxos de trabalho baseados em eventos, mais eficientes do que procurar atualizações no App Store Connect. Como isso funciona?

Supondo que tenha um servidor HTTP, que será seu ouvinte de webhook, você começa fornecendo ao App Store Connect o URL do ouvinte, dizendo ao App Store Connect para onde enviar atualizações. Quando houver uma alteração relevante no App Store Connect, ele enviará uma solicitação POST ao URL registrado. O payload de solicitação contém informações sobre o evento. Com base nesse payload, o sistema pode consultar as APIs App Store Connect para obter mais informações ou executar as ações necessárias. Neste ano, o App Store Connect lançou notificações webhook para eventos importantes, novo envio de feedbacks do TestFlight, mudanças de App version state, Build upload state, Build beta state e Apple-Hosted Background Assets state. Para receber essas notificações do App Store Connect, registre seu ouvinte de webhook primeiro. Vou mostrar como registrar seu ouvinte de webhook no site do App Store Connect. Vá até Usuários e acesso. Selecione Integrações. Em Integrações, há a seção Webhooks na barra lateral. Clique no botão de adição. Isso abrirá o painel para você configurar os detalhes do webhook. Dê um nome descritivo ao webhook. Insira o URL do ouvinte de webhook. Esse é o endpoint para onde o App Store Connect enviará as notificações. Preste atenção no campo Segredo, isso é importante. O App Store Connect usa essa chave secreta para assinar cada notificação webhook. É possível usar qualquer string para o segredo, mas só você e o App Store Connect devem conhecê-la. Essa assinatura permite que o sistema verifique se a notificação veio da Apple.

Por fim, escolha em qual evento deseja se inscrever. Na sessão de hoje, vou ativar os eventos Build Upload, Build Beta State e TestFlight Feedback. Clique em Criar. Pronto. Seus servidores receberão notificações webhook quando esses eventos ocorrerem no app. Você pode configurar o webhook usando a API. Essa abordagem é útil se você gerencia muitos apps ou quer registrar ouvintes de webhook automaticamente para novos apps. Vou mostrar como registrar um ouvinte de webhook com APIs. Para registrar um ouvinte de webhook com as APIs, envie uma solicitação POST ao endpoint de webhook. Os atributos são semelhantes ao que vimos na interface. Envie os eventos em que quer se inscrever, o segredo que o App Store Connect usará para assinar o payload de eventos e o URL do ouvinte de webhook. Após a criação do webhook, você receberá a resposta 201 CREATED. O payload incluirá o ID do webhook, que é necessário para gerenciá-lo depois. Vimos as notificações webhook e como registrar seu ouvinte de webhook com o App Store Connect. É hora de automatizar o upload de uma compilação no App Store Connect com a nova API Build Upload. Uma das principais melhorias que apresentarei é a capacidade de automatizar BuildUploads com a API App Store Connect. Por que a API Build Upload é útil? A nova API Build Upload faz parte de APIs padronizadas do App Store Connect, o que permite adicioná-la ao restante da automação. Você pode fazer upload da compilação usando qualquer linguagem ou plataforma. Se houver problemas no upload, essas novas APIs fornecerão mensagens para automatizar o tratamento de erros. É uma forma nova e flexível de automatizar processos de upload de compilação. Vou mostrar como funciona. Para fazer upload da sua compilação usando a nova API, crie BuildUploads. BuildUploads tem informações da compilação, como versão e plataforma de destino.

Dê ao App Store Connect os detalhes do seu arquivo de compilação usando BuildUploadFiles. O App Store Connect informará como fazer upload da compilação.

Faça upload do binário de compilação seguindo as instruções. A etapa final é informar ao App Store Connect que o upload foi concluído para que processe a nova compilação. Agora, vou explicar os detalhes da API. Para criar BuildUpload, faça uma solicitação POST. Ela deve incluir a versão do pacote da sua compilação e a plataforma de destino. Se a solicitação tiver êxito, o App Store Connect mostrará o status 201 CREATED e um ID exclusivo para este BuildUpload. A próxima etapa é criar um BuildUploadFile para o App Store Connect saber os detalhes do arquivo. Você deverá incluir nome do arquivo, tamanho em bytes e tipo de ativo. Se BuildUploadFile for criado com êxito, você receberá a resposta 201 CREATED. No corpo da resposta, você encontrará operações de upload. Isso informa como fazer upload do seu binário. E fornece o URL ao qual enviar a compilação, ensina a usar o método PUT e lista os cabeçalhos necessários. Assim como em outras APIs para upload de arquivos, talvez você receba instruções para fazer upload da compilação em vários blocos se ela for grande. Nesse caso, faça várias chamadas HTTP com diferentes partes do binário. Após fazer upload da compilação seguindo as instruções da resposta anterior, diga ao App Store Connect que o upload foi concluído. Essa etapa sinaliza que o App Store Connect pode processar a compilação. Para isso, envie uma solicitação PATCH com a propriedade uploaded true.

Se houver êxito, você receberá a resposta 200 OK com o estado COMPLETE. Vou abrir o site do App Store Connect para ver a nova compilação. Ele indica que o App Store Connect começou a processar a nova compilação. Mas levanta uma questão. Quando terminará? E como saberemos? É aí que entra a notificação webhook que configuramos anteriormente. Ela notificará quando esse processamento for concluído. Veja um exemplo do que seu servidor recebe do App Store Connect quando a compilação é processada. A principal alteração é a transição de PROCESSING para COMPLETE. Quando vir o status COMPLETE, terá a confirmação de que a compilação foi processada e que pode ir para a próxima etapa. Você receberá a assinatura da mensagem no cabeçalho X-Apple-SIGNATURE. Isso informa que o App Store Connect usa o algoritmo HMAC-SHA256. Você pode calcular a assinatura com o segredo configurado mais cedo e o corpo do payload recebido e comparar o valor calculado e o do cabeçalho para verificar se a notificação veio do App Store Connect.

Assim, você automatiza o processo de upload de compilações com as APIs. Agora vou passar para testes beta com TestFlight. Após o processamento da compilação pelo App Store Connect, use o TestFlight para distribuí-la para testers beta. Você pode atribuir a compilação a grupos de testers beta específicos. Para testers externos, envie a compilação para o App Review Beta. Informe aos testers que a nova compilação está disponível. Todas essas etapas podem ser automatizadas usando as APIs TestFlight. Estas são algumas das APIs TestFlight fornecidas pelo App Store Connect. Encontre informações abrangentes na documentação da API App Store Connect. No entanto, o ponto principal é que essas APIs permitem automatizar totalmente a distribuição de compilações para testers. Embora essas APIs estejam bem estabelecidas, quero destacar uma nova edição útil deste ano, o evento de webhook Build beta state. Esse novo webhook foi criado para notificar quando a análise beta do TestFlight for concluída. Veja um payload de exemplo de Build beta state notification. Ele mostrará o estado atualizado e incluirá um ID de compilação específico. Com essa notificação, você saberá que a compilação passou na análise e está pronta para testes externos. É assim que você pode usar o TestFlight para distribuir sua compilação. Vamos ver como obter feedback do TestFlight dos testers. O feedback é essencial no TestFlight. Os testers podem enviar feedbacks com capturas de tela para sugestões ou problemas na interface e feedbacks de falhas no app. O feedback do TestFlight fornece informações que ajudam na evolução do app. Tome medidas em relação a ele para uma melhor experiência do usuário. É por isso que saber quando novos feedbacks chegam é importante. Monitore os feedbacks dos testers com as ferramentas de desenvolvimento. Para isso, o App Store Connect lançou a API Feedback com os eventos webhook correspondentes. É um recurso muito aguardado e solicitado pelos desenvolvedores. Vou explorar os detalhes. Quando houver um feedback com captura de tela, você receberá uma notificação webhook com um payload deste tipo. A notificação webhook contém informações mínimas. Contém o tipo de feedback, que é uma captura de tela, e uma instância relacionada. A instância informa que é betaFeedbackScreenshotSubmissions e fornece o ID. Use esse ID para obter os detalhes do feedback. Ao chamar a API Feedback para obter feedbacks com capturas de tela, a resposta terá vários detalhes, como informações do dispositivo e o URL da captura de tela. Use esses URLs para baixar as capturas de tela em chamadas separadas.

Obter feedback de falhas é idêntico a obter feedback com capturas de tela, mas quando o registro de falhas estiver disponível, baixe-o chamando o endpoint crashLog. É assim que você obtém feedback do TestFlight usando a API. E é assim que concluímos este processo de desenvolvimento de apps usando a API App Store Connect. API Webhook e eventos para receber notificações, API Build Upload para fazer upload de uma compilação e API Feedback para obter feedback. Mas existem outras. Se você usa Apple-Hosted Background Assets, novas APIs estão disponíveis para automatizar o gerenciamento de ativos. O App Store Connect enviará eventos App version state webhook para notificar sobre alterações de estado do app na App Store, concluindo o processo desde o desenvolvimento até os testes e o lançamento. O App Store Connect fornece muitas APIs para automatizar diferentes estágios do processo de desenvolvimento. Automatizar tarefas diárias é importante, pois permite focar em uma melhor experiência do usuário. Para finalizar a sessão, farei algumas recomendações. Crie ouvintes de webhook para receber notificações webhook do App Store Connect. Implemente comportamentos reativos baseados em eventos webhook para automatizar processos. Explore o que a API App Store Connect oferece e use essas APIs em sua automação para agilizar o ciclo de desenvolvimento.

Confira as sessões “Descobrir Apple-Hosted Background Assets” e “Novidades do App Store Connect” para saber mais sobre a edição deste ano do App Store Connect. É isso por hoje. Espero que esta sessão tenha sido útil. Agradeço por assistir.