Configurar webhooks en Apple Business Connect
Un socio externo con acceso a la API puede recibir notificaciones push mediante un webhook para cambios de estado que impliquen diferentes recursos y eventos. Los tipos de notificación que se reciben mediante webhooks son equivalentes a los de la API de notificaciones.
Nota: Antes de poder usar un webhook, debes tener acceso a la API de Apple Business Connect y Apple debe aprobar cada entorno. Consulta Solicitar acceso a la API.
Crear tu primer webhook
Si todavía no lo hiciste, inicia sesión en Apple Business Connect con un usuario que tenga la función de administrador.
Si eres el administrador de más de una compañía, selecciona la compañía correspondiente de la lista de compañías
.Selecciona tu compañía en la barra lateral y luego selecciona API debajo del nombre de la compañía.
Selecciona
junto a Agregar webhook y luego ingresa la siguiente información:Información
Descripción
Webhook
Puede contener letras, números y símbolos, excepto los siguientes:
; (punto y coma)
’ (apóstrofe de puntuación)
[ (corchete izquierdo)
] (corchete derecho)
< (signo menor que)
> (signo mayor que)
Miembro del equipo
Un miembro del equipo con la función de administrador o desarrollador al que se contacta en caso de que falle la conexión.
Entorno
Restricciones:
No puedes cambiar de entorno después de configurar un webhook.
Un evento solo puede usarse una vez por entorno.
URL de carga útil
Debe empezar con https://
Eventos
Debe seleccionarse al menos un recurso u otro evento.
Nota: Una vez que se agregue la información del webhook, se envía un ping a la URL para verificar la conexión.
Selecciona Guardar.
Selecciona el botón Copiar para copiar el secreto de cliente a tu portapapeles.
Comparte el secreto de cliente con el administrador del webhook.
Una vez que el administrador haya confirmado que recibió el secreto de cliente, selecciona Listo.
Editar un webhook
Si todavía no lo hiciste, inicia sesión en Apple Business Connect con un usuario que tenga la función de administrador.
Si eres el administrador de más de una compañía, selecciona la compañía correspondiente de la lista de compañías
.Selecciona tu compañía en la barra lateral y luego selecciona API debajo del nombre de la compañía.
Selecciona
junto a Administrar webhooks y luego 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 al que se contacta en caso de que falle la conexión
La URL de carga útil
Si es necesario, selecciona Crear nuevo secreto de cliente y luego selecciona Crear.
Comparte el secreto de cliente con el administrador del webhook.
Una vez que el administrador haya confirmado que recibió el secreto de cliente, selecciona Listo.
Selecciona todos los recursos y eventos de los que deseas recibir notificaciones.
Nota: Los recursos que se usan en el entorno del mismo webhook no están disponibles para más de un webhook.
Selecciona Guardar.
Ver o cambiar el estado de un webhook
Si todavía no lo hiciste, inicia sesión en Apple Business Connect con un usuario que tenga la función de administrador.
Si eres el administrador de más de una compañía, selecciona la compañía correspondiente de la lista de compañías
.Selecciona tu compañía en la barra lateral y luego selecciona API debajo del nombre de la compañía.
Selecciona
junto a Administrar webhooks y luego consulta la lista de webhooks.Cambia el estado del webhook para activarlo o desactivarlo.
La desactivación de un webhook impide que se le envíen notificaciones.
Eliminar un webhook
Si todavía no lo hiciste, inicia sesión en Apple Business Connect con un usuario que tenga la función de administrador.
Si eres el administrador de más de una compañía, selecciona la compañía correspondiente de la lista de compañías
.Selecciona tu compañía en la barra lateral y luego selecciona API debajo del nombre de la compañía.
Selecciona
junto a Administrar webhooks y luego consulta la lista de webhooks.Selecciona un webhook, desplázate hacia abajo y selecciona Eliminar webhook.
Selecciona Eliminar y luego selecciona Guardar.