Automatiza tu proceso de desarrollo con la App Store Connect API

Te damos la bienvenida. Soy Dajinsol Jeon, ingeniero del equipo de App Store Connect. Hoy presentaré actualizaciones de la API de App Store Connect. Comencemos.

App Store Connect ofrece muchas API para automatizar los procesos de desarrollo. Gracias a eso, tu equipo puede enfocarse en crear nuevas y excelentes funcionalidades para los usuarios. Este año, App Store Connect amplió significativamente su API en áreas clave, como la administración de apps y TestFlight. Ahora App Store Connect admite nuevos conjuntos de API, como la esperada API Webhooks y la API Apple-Hosted Background Assets. Hoy repasaremos algunas actualizaciones importantes y muy esperadas, como Webhooks, BuildUpload y Feedback. Pero antes, haré un resumen del proceso típico de desarrollo de apps. El desarrollo de apps es un proceso iterativo. Comienzas con nuevas funcionalidades o correcciones, y cargas una nueva compilación en App Store Connect. Luego de distribuir la nueva versión, los evaluadores beta envían comentarios y en la siguiente fase se incorporan los comentarios de la versión anterior. La clave es ejecutar este ciclo lo más rápido posible. Por ejemplo, cuando los usuarios informan una falla, es mejor solucionarla lo antes posible para mejorar su experiencia. Ahí es donde entran las actualizaciones de hoy. Las nuevas API de App Store Connect te permiten automatizar este ciclo, lo que crea una iteración más rápida. Veamos cómo. Este año, App Store Connect presenta las API Build Upload y Feedback para admitir una mejor automatización. Además, App Store Connect ahora admite notificaciones de Webhook. Tu sistema puede recibir notificaciones cuando algo sucede en tu app y reaccionar ante esos eventos. Por ejemplo, se envía un evento de estado de carga de compilación al receptor webhook al completarse el procesamiento de la compilación cargada. Te indica que puedes continuar con el siguiente paso. Las notificaciones de Webhook también admiten más eventos, como eventos de comentarios y de estado de versión beta, para informarte eventos importantes de tu app. Esto permite que tu ciclo de desarrollo sea más rápido que antes. Ahora, exploraremos estas mejoras con más detalle. Comenzaré con las notificaciones de Webhook. Las API tradicionales son como la pregunta continua de “¿alguna novedad?”. El sistema solicita constantemente actualizaciones a App Store Connect, pero los webhooks cambian la situación. Los webhooks son esencialmente comunicaciones push entre servidores. En lugar de que tu sistema siempre pregunte, App Store Connect envía notificaciones sobre los eventos. Técnicamente, es una devolución de llamada HTTP de App Store Connect a tu servidor al ocurrir un evento específico relacionado con tu app.

Así puedes crear flujos de trabajo basados en eventos, mucho más eficientes que consultar App Store Connect por actualizaciones. ¿Cómo funciona?

Si tienes un servidor HTTP, que será tu receptor webhook, comienzas por dar a App Store Connect la URL del receptor, y así indicas a App Store Connect dónde enviar las actualizaciones. Luego, cuando ocurre un cambio relevante en App Store Connect, envía una solicitud POST a la URL registrada. La carga útil de la solicitud contiene información sobre el evento. Según esa carga útil, tu sistema puede consultar las API de App Store Connect para obtener más información o realizar las acciones necesarias. Este año, App Store Connect incorpora notificaciones de webhook para eventos importantes, envíos de comentarios de TestFlight, cambios de estado de la versión de la app, de la carga de compilación, de la versión beta de compilación y de activos en segundo plano alojados por Apple. Para recibir esas notificaciones de App Store Connect, debes registrar tu receptor webhook. Veamos cómo registrar tu receptor webhook en el sitio web de App Store Connect. Primero, navega a la sección Usuarios y acceso. Luego, selecciona Integraciones. En Integraciones, está la sección Webhooks en la barra lateral. Haz clic en el botón más. Esto abrirá el panel donde podrás configurar los detalles de tu webhook. Primero, dale a tu webhook un nombre descriptivo. Luego, ingresa la URL de tu receptor webhook. Este es el punto final donde App Store Connect enviará las notificaciones. Ahora presta atención al campo Secreto. Esto es importante. App Store Connect usa esta clave secreta para firmar cada notificación de webhook. Puedes usar cualquier clave, pero debe ser conocida solo por App Store Connect y por ti. Esta firma permite que tu sistema verifique que la notificación efectivamente proviene de Apple.

Por último, debes elegir a qué evento deseas suscribirte. Para la sesión de hoy, habilitaré la carga de compilación, el estado de compilación beta y los comentarios de TestFlight. Haz clic en Crear. ¡Eso es todo! Ahora tus servidores recibirán notificaciones de webhook cuando ocurran esos eventos para tu app. También puedes configurar tu webhook usando la API. Este enfoque es muy útil si administras muchas apps o deseas registrar automáticamente receptores webhook para nuevas apps. Veamos cómo registrar un receptor webhook con API. Para registrar un receptor webhook con las API, debe enviar una solicitud POST al punto final del webhook. Los atributos son muy similares a lo que vimos en la IU. Debes enviar los tipos de eventos a los que deseas suscribirte, el secreto que App Store Connect usará para firmar la carga del evento y la URL de tu receptor webhook. Cuando se crea con éxito el webhook, recibes una respuesta 201 CREATED. La carga útil incluirá el ID del webhook, que es necesario para administrarlo más adelante. Así son las notificaciones de webhook y cómo registrar tu receptor webhook con App Store Connect. Ahora veamos cómo automatizar la carga de una nueva compilación a App Store Connect con la nueva API Build Upload. Una de las principales mejoras que presento hoy es la capacidad de automatizar BuildUploads con la API de App Store Connect. Entonces, ¿por qué es útil la API Build Upload? Build Upload es parte de las API estandarizadas de App Store Connect, lo que te permite agregar la carga de compilaciones al resto de tu automatización. Esto también significa que puedes cargar tu compilación usando el idioma o plataforma que prefieras. Si surgen problemas al cargar, estas nuevas API ofrecen mensajes bien formateados para automatizar el manejo de errores. Esto te brinda una forma nueva y más flexible de automatizar la carga de compilaciones. Veamos cómo funciona. Para cargar tu compilación con la nueva API, comienza creando BuildUploads. BuildUploads contiene información de compilación, como la versión y la plataforma de destino.

Luego, proporciona a App Store Connect los detalles de tu archivo de compilación con BuildUploadFiles. App Store Connect ofrece instrucciones sobre cómo cargar tu compilación.

Carga el binario de compilación siguiendo esas instrucciones. El paso final es avisarle a App Store Connect que la carga está completa para que pueda procesar la nueva compilación.

Ahora explicaré los detalles de la API. Para crear un BuildUpload, realiza una solicitud POST. Esta solicitud debe incluir la versión del paquete de la compilación y la plataforma de destino. Si tu solicitud es exitosa, App Store Connect responde con un estado 201 CREATED con un ID único para esta nueva BuildUpload. El siguiente paso es crear un BuildUploadFile para que App Store Connect tenga los detalles del archivo. Debes incluir el nombre del archivo, el tamaño en bytes y el tipo de activo. Si el BuildUploadFile se crea correctamente, obtendrás la respuesta 201 CREATED. En el cuerpo de la respuesta, habrá operaciones de carga. Esto te indica exactamente cómo cargar tu binario. Te ofrece la URL a la cual enviar tu compilación, indica que uses el método PUT y enumera los encabezados necesarios. Como en otras API para cargar archivos, quizás recibas varias instrucciones para cargar tu compilación en varios fragmentos si la carga es grande. En ese caso, necesitarás realizar múltiples llamadas HTTP con diferentes partes de tu binario. Ya cargaste tu compilación según las instrucciones, ahora, debes informar a App Store Connect que la carga realmente finalizó. Este paso indica a App Store Connect que comience a procesar tu nueva compilación. Para eso, envía una solicitud PATCH con la propiedad uploaded como true.

Si tienes éxito, obtienes respuestas 200 OK con el estado COMPLETE. Ahora, abriré el sitio web de App Store Connect para ver la nueva compilación. El sitio web que comenzó a procesar la nueva compilación. Pero aquí surge una pregunta clave. ¿Cuando finalizará? ¿Y cómo lo sabremos? Ahí es donde entra en juego la notificación del webhook, la cual configuramos antes. Te avisará cuando se complete este procesamiento. Éste es un ejemplo de lo que tu servidor recibe de App Store Connect cuando tu compilación se procesa correctamente. El cambio clave es la transición de estado de PROCESSING a COMPLETE. Cuando veas el estado en COMPLETE, tendrás la confirmación de que la compilación se procesó y podrás continuar con el siguiente paso. También obtendrás la firma del mensaje en el encabezado X-Apple-SIGNATURE. Esto indica que App Store Connect usa el algoritmo HMAC-SHA256. Calcula la firma con el secreto que configuraste y el cuerpo de carga que recibiste, y compara el valor calculado y el valor del encabezado para verificar que la notificación vino de App Store Connect.

Así se automatiza el proceso de carga de compilaciones con las nuevas API. Pasemos a las pruebas beta con TestFlight. Cuando App Store Connect procese tu compilación, podrás usar TestFlight para distribuir tu nueva compilación a los evaluadores beta. Puedes asignar la compilación directamente a tus grupos de evaluadores beta específicos. Para los evaluadores externos, primero deberás enviar la compilación para la revisión de la App Beta. Por último, querrás notificar a los evaluadoresque la nueva compilación está disponible. La buena noticia es que todos estos pasos se pueden automatizar con las API de TestFlight. Estas son algunas de las API de TestFlight que App Store Connect ofrece. Puedes encontrar información completa en la documentación de la API de App Store Connect. Pero el punto clave que quiero que recuerdes es que estas API te permiten automatizar completamente la distribución de compilaciones a tus evaluadores. Si bien esas API están bien establecidas, quiero destacar una nueva edición útil este año: el evento webhook del estado beta de compilación. Este nuevo webhook está diseñado para notificarte de inmediato cuando se complete la revisión beta de TestFlight. Este es un ejemplo de carga útil de una notificación del estado de una versión beta de compilación. La carga útil mostrará el estado actualizado e incluirá una ID de compilación específica. Cuando recibas esta notificación, sabrás que tu compilación pasó la revisión y está lista para pruebas externas. Así es como puedes usar TestFlight para distribuir tu nueva compilación. Ahora, veamos cómo obtener comentarios de los evaluadores de TestFlight. Los comentarios son una parte clave del uso de TestFlight. Los evaluadores pueden enviar comentarios de captura de pantalla para realizar sugerencias o informar problemas de IU cuando ven fallas en la app. Con los comentarios de TestFlight, puedes descubrir conocimientos que impulsan la evolución de tu app. Reaccionar rápido a los comentarios es importante para una mejor experiencia del usuario. Por eso es importante saber al instante cuando llega un nuevo comentario. Además, como no querrás perderte ningún comentario, es muy útil darles seguimiento con tus herramientas de desarrollo. Para eso, App Store Connect presenta la nueva API de comentarios junto con los eventos webhoock correspondientes. Esta es una capacidad muy esperada y solicitada por quienes desarrollan. Exploremos los detalles. Cuando haya nuevos comentarios con capturas de pantalla, recibirás una notificación de webhook con una carga útil similar a esta. La notificación del webhook contiene información mínima. Tiene el tipo de comentarios, la captura de pantalla en este caso, y una instancia relacionada. La instancia te informa que se trata de envíos de capturas de pantalla de comentarios beta y ofrece el ID. Puedes usar esta ID para recuperar los detalles de estos comentarios. Al invocar la API Feedback para recuperar comentarios de captura de pantalla, tu respuesta tendrá detalles, como la información del dispositivo y la URL de la captura de pantalla. Puedes usar estas URL para descargar las imágenes de captura de pantalla en llamadas separadas.

Obtener comentarios sobre fallas es igual a obtenerlos sobre capturas de pantalla, y si el registro de fallas está disponible, puedes descargarlo de forma programática con el punto final crashLog. Así es como se recuperan los comentarios de TestFlight mediante la API. Y así es como completamos este proceso de desarrollo de apps usando la API de App Store Connect. API Webhook y eventos para recibir notificaciones, API Build Upload para cargar una nueva compilación y API Feedback para recuperar comentarios. Pero hay más. Por ejemplo, si usas Apple-Hosted Background Asset, hay nuevas API disponibles para automatizar la administración de activos. Y App Store Connect envía eventos webhook de la versión de la app para notificarte los cambios de estado de tu app en el App Store, así completas el proceso de desarrollo, pruebas y lanzamiento. Además, App Store Connect ofrece muchas API existentes para automatizar diferentes etapas de tu proceso de desarrollo. De nuevo, automatizar tus tareas diarias es importante porque te permite concentrarte más en una mejor experiencia del usuario. Finalizaremos la sesión de hoy con algunas recomendaciones. Primero, crea receptores webhook para que puedas recibir notificaciones de webhook de App Store Connect. Luego, implementa comportamientos reactivos basados en eventos de webhook para automatizar sus procesos. Por último, explora qué más ofrece la API de App Store Connect y usa estas API en tu automatización para un ciclo de desarrollo más rápido.

Consulta las sesiones “Descubre los activos en segundo plano alojados por Apple” y “Novedades en App Store Connect” para más información sobre la edición de este año en App Store Connect. Eso es todo por hoy. Espero que la sesión te haya resultado útil. Gracias por acompañarnos.