Configurer des webhooks dans Apple Business
Un partenaire tiers qui dispose d’un accès à l’API peut recevoir des notifications push à l’aide d’un webhook en cas de modification du statut de différents évènements et ressources. Ces types de notification reçus à l’aide des webhooks vont de pair avec celles qui proviennent de l’API Notifications.
Remarque : Avant de pouvoir utiliser un webhook, vous devez disposer d’un accès API à Apple Business et chaque environnement doit être approuvé par Apple. Consultez la section Demander l’accès à l’API.
Créer votre premier webhook
Dans Apple Business, connectez-vous avec un profil utilisateur dont le rôle est Administrateur d’organisation.
Pour afficher les rôles et les autorisations, consultez la section Introduction aux rôles et autorisations.
Dans votre Navigateur, sélectionnez Réglages > Accès partenaire.
Sélectionnez API.
Sélectionnez
à côté d’Ajouter un webhook, puis saisissez les informations suivantes :Informations
Description
Webhook
Peut contenir des lettres, des chiffres et des symboles, à l’exception des éléments suivants :
; (point-virgule)
’ (apostrophe)
[ (crochet ouvrant)
] (crochet fermant)
< (signe plus petit que)
> (signe plus grand que)
Membre d’équipe
Un membre d’équipe qui dispose du rôle Administrateur ou Développeur et qui est contacté en cas d’échec de la connexion
Environnement
Restrictions :
Vous ne pouvez pas changer d’environnement après avoir configuré un webhook.
Un évènement ne peut être utilisé qu’une seule fois par environnement.
URL de l’entité
Doit commencer par https://.
Évènements
Au moins une ressource ou un autre évènement doit être sélectionné.
Remarque : Une fois que les informations du webhook sont ajoutées, un ping est envoyé à l’URL pour vérifier la connexion.
Sélectionnez Enregistrer.
Sélectionnez Copier pour copier là clé secrète client dans votre presse-papiers.
Communiquez-la à l’administrateur du webhook.
Une fois que celui-ci a confirmé qu’il a bien reçu la clé secrète client, sélectionnez Terminé.
Modifier un webhook
Dans Apple Business, connectez-vous avec un profil utilisateur dont le rôle est Administrateur d’organisation.
Pour afficher les rôles et les autorisations, consultez la section Introduction aux rôles et autorisations.
Dans votre Navigateur, sélectionnez Réglages > Accès partenaire.
Sélectionnez API.
Sélectionnez
à côté de Gérer les webhooks, puis sélectionnez un webhook dans la liste.Vous pouvez modifier les éléments suivants :
Le nom du webhook
Le statut du webhook
Le nom du membre de l’équipe qui est contacté en cas d’échec de la connexion
L’URL de l’entité
Si nécessaire, sélectionnez Créer une nouvelle clé secrète de client, puis Créer.
Communiquez-la à l’administrateur du webhook.
Une fois que celui-ci a confirmé qu’il a bien reçu la clé secrète client, sélectionnez Terminé.
Sélectionnez l’ensemble des ressources et des évènements au sujet desquels vous souhaitez recevoir des notifications.
Remarque : Les ressources utilisées dans le même environnement de webhook ne sont disponibles que pour un seul webhook.
Sélectionnez Enregistrer.
Voir ou modifier le statut d’un webhook
Dans Apple Business, connectez-vous avec un profil utilisateur dont le rôle est Administrateur d’organisation.
Pour afficher les rôles et les autorisations, consultez la section Introduction aux rôles et autorisations.
Dans votre Navigateur, sélectionnez Réglages > Accès partenaire.
Sélectionnez API.
Sélectionnez
à côté de Gérer les webhooks, puis affichez la liste des webhooks.Changez le statut du webhook pour l’activer ou le désactiver.
Si vous désactivez un webhook, il ne recevra plus de notifications.
Supprimer un webhook
Dans Apple Business, connectez-vous avec un profil utilisateur dont le rôle est Administrateur d’organisation.
Pour afficher les rôles et les autorisations, consultez la section Introduction aux rôles et autorisations.
Dans votre Navigateur, sélectionnez Réglages > Accès partenaire.
Sélectionnez API.
Sélectionnez
à côté de Gérer les webhooks, puis affichez la liste des webhooks.Sélectionnez un webhook, puis faites défiler la page vers le bas et sélectionnez Supprimer le webhook.
Sélectionnez Supprimer, puis Enregistrer.