Configurer les liens de rappel HTTP dans Apple Business
Un partenaire tiers ayant accès à l’API peut recevoir des notifications poussées par le biais d’un lien de rappel HTTP pour les changements d’état impliquant différentes ressources et événements. Les types de notifications disponibles via les liens de rappel HTTP correspondent à ceux disponibles via l’API Notifications.
Remarque : Avant de pouvoir utiliser un lien de rappel HTTP, vous devez avoir accès à l’API à Apple Business et chaque environnement doit être approuvé par Apple. Consultez Demande d’accès à l’API.
Créer votre premier lien de rappel HTTP
Dans Apple Business, connectez-vous avec un utilisateur dont le rôle est celui d’Administrateur d’organisation ou d’Administrateur marketing.
Pour consulter les rôles et les autorisations, consultez la section Introduction aux rôles et aux autorisations.
Dans votre navigateur, choisissez Réglages > Intégrations > API.
Sélectionnez l’API.
Sélectionnez
à côté de Ajouter un lien de rappel HTTP, puis entrez les informations suivantes :Renseignement
Description
Lien de rappel HTTP
Peut contenir des lettres, des chiffres et des symboles, à l’exception des éléments suivants :
; (Point-virgule)
’ (Apostrophe de ponctuation)
[ (crochet gauche)
] (crochet droit)
< (Signe inférieur à)
> (Signe supérieur à)
Membre de l’équipe
Un utilisateur ayant le rôle d’Administrateur de l’organisation ou d’Administrateur marketing, qui est contacté en cas d’échec de la connexion
Environnement
Restrictions :
Vous ne pouvez pas modifier l’environnement après avoir configuré un lien de rappel HTTP
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 : Lorsque vous sélectionnez Enregistrer, un ping est envoyé à l’URL pour vérifier la connexion.
Sélectionnez Enregistrer.
Sélectionnez Copier pour copier la clé secrète client dans votre presse-papiers.
Partagez la clé secrète client avec l’administrateur du lien de rappel HTTP.
Une fois que l’administrateur a confirmé avoir reçu la clé secrète client, sélectionnez Terminé.
Modifier un lien de rappel HTTP
Dans Apple Business, connectez-vous avec un utilisateur dont le rôle est celui d’Administrateur d’organisation ou d’Administrateur marketing.
Pour consulter les rôles et les autorisations, consultez la section Introduction aux rôles et aux autorisations.
Dans votre navigateur, choisissez Réglages > Intégrations > API.
Sélectionnez l’API.
Sélectionnez
à côté de Gérer les liens de rappel HTTP, puis sélectionnez un lien de rappel HTTP dans la liste.Vous pouvez modifier ce qui suit :
Le nom du lien de rappel HTTP
L’état du lien de rappel HTTP
Le nom d’un·e utilisateur ou utilisatrice à contacter en cas d’échec de la connexion
L’URL de l’entité
Si nécessaire, sélectionnez Créer une nouvelle clé secrète client, puis sélectionnez Créer.
Remarque : Le secret client est une information d’identification à usage unique qui ne peut pas être récupérée après la fin de la session, c’est pourquoi un partage et une confirmation manuels sont nécessaires.
Partagez la clé secrète client avec l’administrateur du lien de rappel HTTP.
Une fois que l’Administrateur de l’organisation a confirmé avoir reçu le secret client, sélectionnez Terminé.
Sélectionnez toutes les ressources et tous les événements pour lesquels vous voulez être informé·e.
Remarque : Les ressources utilisées dans un même environnement Lien de rappel HTTP ne sont pas accessibles à plus d’un lien de rappel HTTP.
Sélectionnez Enregistrer.
Afficher ou modifier le statut d’un lien de rappel HTTP
Dans Apple Business, connectez-vous avec un utilisateur dont le rôle est celui d’Administrateur d’organisation ou d’Administrateur marketing.
Pour consulter les rôles et les autorisations, consultez la section Introduction aux rôles et aux autorisations.
Dans votre navigateur, choisissez Réglages > Intégrations > API.
Sélectionnez l’API.
Sélectionnez
à côté de Gérer les liens de rappel HTTP, puis consultez la liste des liens de rappel HTTP.Modifier l’état du lien de rappel HTTP pour l’activer ou le désactiver.
La désactivation d’un lien de rappel HTTP arrête la réception des notifications.
Supprimer un lien de rappel HTTP
Dans Apple Business, connectez-vous avec un utilisateur dont le rôle est celui d’Administrateur d’organisation ou d’Administrateur marketing.
Pour consulter les rôles et les autorisations, consultez la section Introduction aux rôles et aux autorisations.
Dans votre navigateur, choisissez Réglages > Intégrations > API.
Sélectionnez l’API.
Sélectionnez
à côté de Gérer les liens de rappel HTTP, puis consultez la liste des liens de rappel HTTP.Sélectionnez un lien de rappel HTTP, puis faites défiler vers le bas et sélectionnez Supprimer le lien de rappel HTTP.
Sélectionnez Supprimer, puis Enregistrer.