Configurar webhooks en Apple Business
Las compañías asociadas con acceso a la API pueden recibir notificaciones push mediante un webhook para los cambios de estado que afectan a distintos recursos y eventos. Los tipos de notificación que se reciben mediante webhooks son equivalentes a los de la API de notificaciones.
Nota: Para poder usar un webhook, debes tener acceso a la API de Apple Business y Apple debe aprobar cada entorno. Consulta Acceso compartido a la API.
Crear el primer webhook
En Apple Business, inicia sesión con un usuario que tenga la función de Administrador de la organización.
Para ver las funciones y permisos, consulta Introducción a las funciones y los permisos.
En tu navegador, selecciona Ajustes > Acceso de compañía asociada.
Selecciona API.
Selecciona
junto a “Añadir webhook” e introduce la siguiente información:Información
Descripción
Webhook
Puede contener letras, números y símbolos, excepto los siguientes:
; (punto y coma)
’ (apóstrofo)
[ (corchete izquierdo)
] (corchete derecho)
< (símbolo “menor que”)
> (símbolo “mayor que”)
Miembro del equipo
Un miembro del equipo con la función de Administrador o Desarrollador con el que se contactará si falla la conexión
Entorno
Restricciones:
No puedes cambiar de entorno después de configurar un webhook
Los eventos solo se pueden usar una vez por entorno
URL de carga útil
Tiene que empezar con https://
Eventos
Se debe seleccionar al menos un recurso u otro evento
Nota: Una vez añadida la información del webhook, se envía un ping a la URL para verificar la conexión.
Selecciona Guardar.
Selecciona “Copiar” para copiar el secreto de cliente en el portapapeles.
Comparte el secreto de cliente con el administrador del webhook.
Cuando el administrador haya confirmado que ha recibido el secreto de cliente, selecciona Aceptar.
Editar un webhook
En Apple Business, inicia sesión con un usuario que tenga la función de Administrador de la organización.
Para ver las funciones y permisos, consulta Introducción a las funciones y los permisos.
En tu navegador, selecciona Ajustes > Acceso de compañía asociada.
Selecciona API.
Selecciona
junto a Gestionar webhooks y selecciona un webhook de la lista.Puedes cambiar lo siguiente:
El nombre del webhook
El estado del webhook
El nombre de un miembro del equipo con el que se contacta en caso de que la conexión falle
La URL de carga útil
Si es necesario, selecciona “Crear nuevo secreto de cliente” y, a continuación, selecciona Crear.
Comparte el secreto de cliente con el administrador del webhook.
Cuando el administrador haya confirmado que ha recibido el secreto de cliente, selecciona Aceptar.
Selecciona todos los recursos y eventos sobre los que quieras recibir notificaciones.
Nota: Los recursos que se usan en el mismo entorno de webhook no están disponibles para más de un webhook.
Selecciona Guardar.
Ver o cambiar el estado de un webhook
En Apple Business, inicia sesión con un usuario que tenga la función de Administrador de la organización.
Para ver las funciones y permisos, consulta Introducción a las funciones y los permisos.
En tu navegador, selecciona Ajustes > Acceso de compañía asociada.
Selecciona API.
Selecciona
junto a Gestionar webhooks y echa un vistazo a la lista de webhooks.Cambia el estado del webhook para activarlo o desactivarlo.
Si desactivas un webhook, se dejan de enviar notificaciones al mismo.
Eliminar un webhook
En Apple Business, inicia sesión con un usuario que tenga la función de Administrador de la organización.
Para ver las funciones y permisos, consulta Introducción a las funciones y los permisos.
En tu navegador, selecciona Ajustes > Acceso de compañía asociada.
Selecciona API.
Selecciona
junto a Gestionar webhooks y echa un vistazo a la lista de webhooks.Selecciona un webhook, desplázate hacia abajo y selecciona “Eliminar webhook”.
Selecciona Eliminar y, a continuación, Guardar.