Automatisez votre processus de développement avec l’API App Store Connect

Bienvenue. Je m’appelle Dajinsol Jeon et je suis ingénieur au sein de l’équipe App Store Connect. Aujourd’hui, je vais vous présenter les nouveautés de l’API App Store Connect. Allons-y.

App Store Connect offre de nombreuses API pour automatiser les processus de développement. Votre équipe peut ainsi consacrer plus de temps à l’essentiel, à savoir la création de fonctionnalités utiles. Cette année, App Store Connect a largement étendu son API à des domaines clés comme la gestion des apps et TestFlight. En outre, App Store Connect prend désormais en charge de nouveaux ensembles d’API, dont l’API Webhooks tant attendue et l’API Apple-Hosted Background Assets. Je vais aborder quelques mises à jour importantes attendues depuis longtemps, telles que les API Webhooks, BuildUpload et Feedback. Mais d’abord, récapitulons le processus typique de développement d’une app. Le développement d’une app est un processus itératif. Vous ajoutez des fonctionnalités ou des correctifs, puis chargez un nouveau build dans App Store Connect. Une fois le nouveau build distribué, les testeurs bêta envoient du feedback qui sera pris en compte dans la prochaine phase de développement. Ce cycle doit être aussi rapide que possible. Par exemple, lorsqu’une panne est signalée, corrigez-la dès que possible pour une meilleure expérience utilisateur. C’est là qu’interviennent les mises à jour. Les nouvelles API App Store Connect permettent d’automatiser cette boucle, ce qui accélère grandement l’itération. Voyons comment. Cette année, App Store Connect inclut les API Build upload et Feedback pour faciliter l’automatisation. App Store Connect prend désormais aussi en charge les notifications Webhook. En cas d’événement sur votre app, le système peut recevoir une notification et réagir en conséquence. Par exemple, App Store Connect envoie un événement d’état de chargement de build à l’écouteur de webhook à la fin du traitement du build chargé. Il signale que vous pouvez passer à l’étape suivante. Les notifications Webhook prennent en charge plus d’événements, comme les événements de feedback ou d’état bêta de build, pour indiquer les événements clés concernant votre app. Ces ajouts contribuent à accélérer le cycle de développement. Examinons maintenant ces améliorations plus en détail. Commençons par les notifications Webhook. Les API traditionnelles sont constamment à l’affût de nouveaux événements. Votre système interroge sans cesse App Store Connect, mais les webhooks inversent la situation. Les webhooks sont essentiellement des communications push entre serveurs. Au lieu d’être interrogé par le système, App Store Connect envoie des notifications sur les événements. Techniquement parlant, un rappel HTTP a lieu entre App Store Connect et le serveur

en cas d’événement spécifique lié à votre app.

Vous pouvez ainsi créer des workflows basés sur les événements, ce qui est beaucoup plus efficace que d’interroger constamment App Store Connect. Comment est-ce possible ?

En supposant que vous disposiez d’un serveur HTTP, qui sera l’écouteur de webhook, commencez par donner à App Store Connect l’URL de l’écouteur, ce qui indiquera à App Store Connect où envoyer les mises à jour. À chaque modification pertinente dans App Store Connect, une requête POST sera ensuite envoyée à l’URL enregistrée. Les données utiles de la requête contiennent des informations sur l’événement. Selon ces données, le système pourra interroger les API App Store Connect pour obtenir encore plus d’informations ou effectuer les actions nécessaires. Cette année, App Store Connect inclut les notifications webhook pour les événements clés, l’envoi de feedback TestFlight ainsi que les changements d’état de version d’app, de chargement de build, de build bêta et de ressources en arrière-plan hébergées par Apple. Pour recevoir ces notifications d’App Store Connect, vous devez d’abord enregistrer l’écouteur de webhook. Voyons comment enregistrer l’écouteur de webhook sur le site web App Store Connect. Tout d’abord, accédez à la section Utilisateurs et accès. Sélectionnez ensuite Intégrations. La section Webhooks se trouve dans la barre latérale d’Intégrations. Cliquez sur le bouton plus. Cela ouvre la sous-fenêtre de configuration des détails du webhook. Donnez un nom descriptif au webhook. Puis, saisissez l’URL de l’écouteur de webhook. Il s’agit du point de terminaison où App Store Connect enverra les notifications. Concentrez-vous maintenant sur le champ Secret, à ne pas négliger. App Store Connect utilise cette clé secrète pour signer chaque notification webhook. Utilisez n’importe quelle chaîne pour ce secret. Seulement App Store Connect et vous-même devez la connaître. Cette signature permet au système de vérifier que la notification provient bien d’Apple.

Enfin, choisissez à quel événement vous abonner. Pour cette session, je vais activer les événements de chargement de build, d’état bêta de build et de feedback TestFlight. Je clique sur Créer. Et voilà ! Désormais, à chaque événement de ce type sur votre app, vos serveurs recevront des notifications webhook. Vous pouvez aussi configurer le webhook à l’aide de l’API. Cela est particulièrement utile si vous gérez de nombreuses apps ou pour enregistrer automatiquement des écouteurs de webhook pour les nouvelles apps. Voyons comment enregistrer un écouteur de webhook avec des API. Pour enregistrer un écouteur de webhook avec les API, envoyez une requête POST au point de terminaison du webhook. Les attributs sont très similaires à ce que nous avons vu dans l’interface utilisateur. Envoyez les types d’événements auxquels vous voulez vous abonner, le secret utilisé par App Store Connect pour signer les données utiles des événements et l’URL de l’écouteur de webhook. Une fois le webhook créé, vous recevez une réponse 201 CREATED. La charge utile inclut l’ID du webhook, qui sera nécessaire pour gérer le webhook par la suite. Voilà ce que sont les notifications webhook et comment enregistrer l’écouteur de webhook auprès d’App Store Connect. Passons à l’automatisation du chargement d’un nouveau build dans App Store Connect avec la nouvelle API Build upload. L’une des principales améliorations que je présente aujourd’hui est l’automatisation des chargements de build avec l’API App Store Connect. En quoi l’API Build upload est-elle utile ? Cette nouvelle API fait partie des API App Store Connect standardisées, ce qui vous permet de l’ajouter au reste de votre automatisation. Elle vous permet aussi de charger le build dans le langage ou sur la plate-forme de votre choix. En cas de problèmes lors du chargement, ces API offrent des messages clairs pour faciliter l’automatisation de la gestion des erreurs. Vous pouvez ainsi automatiser les processus de chargement de build de manière plus flexible. Voyons comment cela fonctionne. Pour charger un build à l’aide de la nouvelle API, commencez par créer des BuildUploads. Les BuildUploads contiennent des informations de build telles que la version et la plate-forme cible.

Fournissez à App Store Connect les détails du fichier de build à l’aide de BuildUploadFiles. App Store Connect vous donne ensuite des instructions pour charger le build.

Suivez ces instructions pour charger le binaire de votre build. La dernière étape consiste à informer App Store Connect de la fin du chargement afin qu’il commence à traiter le nouveau build. Passons maintenant en revue les détails de l’API. Pour créer un BuildUpload, effectuez une requête POST. Cette requête doit inclure la version de lot du build et la plate-forme cible. Si la requête est acceptée, App Store Connect répond avec l’état 201 CREATED et un identifiant unique pour ce nouveau BuildUpload. L’étape suivante consiste à créer un fichier BuildUploadFile et d’en fournir les détails à App Store Connect. Vous devez inclure le nom du fichier, sa taille en octets et le type de ressource. Une fois le fichier BuildUploadFile créé, vous recevez la réponse 201 CREATED. Le corps de la réponse comprend les opérations de chargement. Il vous indique exactement comment charger le binaire. Il vous donne l’URL à laquelle envoyer le build, vous indique d’utiliser la méthode PUT et répertorie les en-têtes requis. Comme pour les autres API App Store Connect de chargement de fichiers, vous pouvez recevoir plusieurs instructions pour charger le build en plusieurs blocs s’il est volumineux. Dans ce cas, vous devrez effectuer plusieurs appels HTTP avec différentes parties du binaire. Après avoir chargé le build en suivant les instructions de la réponse précédente, vous devez indiquer à App Store Connect que le chargement est terminé. Cette étape indique à App Store Connect qu’il peut commencer à traiter le nouveau build. Pour ce faire, envoyez une requête PATCH avec la propriété uploaded true.

En cas de succès, vous recevrez des réponses 200 OK avec l’état COMPLETE. Ouvrons le site web App Store Connect pour voir le nouveau build. Le site web App Store Connect indique que le traitement du nouveau build a commencé. Une question clé se pose. Quand se terminera-t-il ? Et comment le saurons-nous ? C’est là qu’intervient la notification de webhook que nous avons configurée précédemment. Elle vous informera dès que ce traitement sera terminé. Voici un exemple de ce que le serveur reçoit d’App Store Connect lorsque le build est traité. Le changement clé est la transition d’état de PROCESSING à COMPLETE. Une fois que vous voyez l’état COMPLETE, vous avez la confirmation que le build est traité et que vous pouvez passer à l’étape suivante. Vous recevez également la signature du message dans l’en-tête x-apple-signature. Cela vous indique qu’App Store Connect utilise l’algorithme HMAC-SHA256. Vous pouvez calculer la signature avec le secret configuré précédemment et le corps de la charge utile que vous avez reçu, et comparer la valeur calculée et la valeur d’en-tête pour vérifier que la notification provient bien d’App Store Connect.

Voilà comment automatiser le processus de chargement de build avec les nouvelles API. Passons maintenant aux tests bêta avec TestFlight. Une fois le build traité par App Store Connect, vous pouvez utiliser TestFlight pour distribuer ce nouveau build aux testeurs bêta. Vous pouvez l’attribuer directement à vos groupes de testeurs bêta spécifiques. Pour les testeurs externes, il devra d’abord passer par la procédure de vérification des apps en version bêta. Enfin, vous devez informer les testeurs que le nouveau build est disponible. L’avantage est que toutes ces étapes peuvent être automatisées à l’aide des API TestFlight. Voici quelques-unes des API TestFlight fournies par App Store Connect. Vous trouverez des informations complètes dans la documentation de l’API App Store Connect. Cependant, le point clé à retenir est que ces API vous permettent d’automatiser entièrement la distribution des builds à vos testeurs. Bien que ces API soient bien établies, je tiens à souligner une nouvelle édition utile cette année, l’événement de webhook d’état bêta de build. Ce nouveau webhook est conçu pour vous avertir immédiatement à la fin de la vérification de la version bêta de TestFlight. Voici un exemple de charge utile d’une notification d’état bêta de build. La charge utile affiche l’état mis à jour et inclut un ID de build spécifique. Lorsque vous recevez cette notification, vous savez que le build a passé la vérification et qu’il est prêt pour les tests externes. Vous savez maintenant comment utiliser TestFlight pour distribuer votre nouveau build. Parlons maintenant du feedback des testeurs sur TestFlight. Le feedback est un élément clé de l’utilisation de TestFlight. Les testeurs peuvent envoyer des captures d’écran pour faire des suggestions ou signaler des problèmes d’interface utilisateur, et du feedback sur les pannes de l’app. Le feedback de TestFlight permet de découvrir des informations qui orientent l’évolution de votre app. Pour une meilleure expérience utilisateur, vous devez réagir rapidement au feedback. C’est pourquoi il est important d’être informé directement en cas de nouveau feedback. Et pour ne pas passer à côté du feedback de vos testeurs, le suivi du feedback avec vos outils de développement est très utile. Pour ce faire, App Store Connect inclut la nouvelle API Feedback avec des événements de webhook correspondants. De nombreux développeurs attendaient cette fonctionnalité depuis longtemps. Voyons cela de plus près. Lorsqu’une capture d’écran est envoyée comme feedback, vous recevez une notification de webhook avec une charge utile similaire à celle-ci. Cette notification contient des informations minimales. Elle inclut le type de feedback, qui est ici une capture d’écran, et un exemple annexe. Cet exemple indique qu’il s’agit de l’envoi d’une capture d’écran de feedback bêta et donne l’identifiant. Vous pouvez utiliser cet identifiant pour récupérer les détails de ce feedback. Lorsque vous appelez l’API Feedback pour récupérer une capture d’écran, la réponse contient divers détails, notamment des informations sur l’appareil et l’URL de cette capture d’écran. Ces URL permettent de télécharger les images de captures d’écran lors d’appels séparés.

La réception du feedback sur les pannes s’apparente à celui des captures d’écran, mais quand le journal des pannes est disponible, vous pouvez le télécharger par programmation en appelant le point de terminaison crashLog. Vous savez maintenant comment récupérer le feedback TestFlight à l’aide de l’API. Vous savez maintenant aussi comment utiliser l’API App Store Connect pour effectuer le processus de développement d’app. L’API Webhook et les événements pour recevoir des notifications, l’API Build upload pour charger le build et l’API Feedback pour collecter le feedback. Mais ce n’est pas tout. Par exemple, si vous utilisez une ressource en arrière-plan hébergée par Apple, de nouvelles API permettent d’automatiser la gestion des ressources. App Store Connect envoie des événements de webhook d’état de version pour vous informer des changements d’état de l’app dans l’App Store, et pour terminer ainsi le processus, du développement à la publication, en passant par les tests. De plus, App Store Connect fournit de nombreuses API pour automatiser différentes étapes du processus de développement. L’automatisation des tâches quotidiennes est essentielle, car elle vous permet de vous consacrer davantage à l’amélioration de l’expérience utilisateur. Pour conclure, voici quelques recommandations. D’abord, créez des écouteurs de webhook afin de pouvoir recevoir les notifications de webhook à partir d’App Store Connect. Ensuite, implémentez des comportements réactifs basés sur les événements de webhook pour automatiser les processus. Enfin, explorez les autres possibilités offertes par l’API App Store Connect et utilisez ces API dans l’automatisation pour un cycle de développement encore plus rapide.

Pensez aussi à regarder les sessions « Discover Apple-Hosted Background Assets » et « What’s new in App Store Connect » pour en savoir plus sur l’édition de cette année dans App Store Connect. Et voilà ! J’espère que vous avez trouvé cette présentation utile. Merci de votre attention !