Pour: Administrateurs
Créer une clé API
Créez une clé de gestion pour l'API du panneau d'administration ou une clé de hub pour l'API du portail, limitez-la à vos adresses IP et copiez-la une seule fois.
Dans cet article8 sections
Une clé APIClé Un jeton secret, créé dans la section Intégration, qui permet à votre propre logiciel d'utiliser l'API du hub. permet à votre propre logiciel, comme un système de gestion de cas, de fonctionner en collaboration avec votre hub. Une clé de gestion utilise l’API du panel d’administration pour gérer les cas et les personnes concernées ; une clé de hub, quant à elle, utilise l’API du portail pour gérer les tâches liées aux cas. Comprenez ce que l’API peut faire.
Clés ouvertes
Veuillez aller à Intégration › Clés et sélectionner NOUVEAU.
Nommez-le
Sous La description, indiquez ce qui sera utilisé par cette fonction, comme par exemple la synchronisation des cas.
Limiter son utilisation
Sous CIDR source, saisissez l’adresse IPv4 publique à partir de laquelle votre système fait des appels, par exemple 203.0.113.10, ou un intervalle d’adresses, comme 203.0.113.0/24. Les appels provenant d’autres endroits seront rejetés. Le hub ne reconnaît que les adresses IPv4 ; donc, les adresses IPv6 sont refusées.
Si vous ne connaissez pas l’adresse, laissez la case vide. Cela permettra de saisir n’importe quelle adresse. Après le premier appel du système, Dernière adresse IP utilisée affichera cette adresse ; voir Restreindre ou annuler une clé API.
Choisissez son type
Sous Domaine, choisissez Manage pour l’API du panneau d’administration, ou Hub pour l’API du portail. Ce choix ne peut être modifié par la suite.
Allumez-le et ajoutez-le
Actif commence à fonctionner. Laissez-le activé : une touche inactive ne sera pas autorisée lors de chaque appel. Choisissez Ajouter une clé. L’information “Touche ajoutée” s’affiche alors.
Copiez la clé
La fenêtre Clef secrète affiche la clé uniquement une fois. Sélectionnez le bouton de copie, Copier dans le presse-papiers, et conservez la clé dans un endroit où le développeur peut y avoir accès en toute sécurité, comme par exemple dans un gestionnaire de mots de passe. Ensuite, sélectionnez Terminé.
Que se passe-t-il ensuite ?
Cette clé est envoyée immédiatement, et elle ne s’éteint pas. Votre développeur la transmet avec chaque appel ; voir Authentification des demandes API avec une clé. Elle fonctionne comme l’Assistante virtuelleAssistant virtuel Un membre d'équipe automatisé qui publie des messages de bienvenue, des enregistrements et des publications pour l'entreprise ; ses publications portent un badge d'assistant virtuel. de votre hub. Ainsi, tout ce qu’elle publie est considéré comme étant celui de l’Assistante virtuelle.
Dernière utilisation et Dernière adresse IP utilisée indiquent la date et l’adresse de la dernière appel effectué avec cette clé API. Pour l’effacer ou la désactiver, veuillez consulter la section Restreindre ou annuler une clé API.
Si quelque chose tourne mal
- “Le nombre de clés autorisées a été atteint.” Votre hub peut avoir deux clés de chaque type. Supprimez l’une des clés que vous n’utilisez plus.
- Selon la source CIDR, « le bloc d’adresses est invalide. Exemple : 203.0.113.10 ou 203.0.113.0/24 ». Vérifiez l’adresse : quatre chiffres de 0 à 255, séparés par des points. Pour désigner une plage de valeurs, il suffit d’utiliser un barre oblique suivi d’un nombre jusqu’à 32.
- Selon la source CIDR, il est nécessaire d’utiliser une adresse IPv4 ou un intervalle d’adresses IPv4, comme par exemple 203.0.113.10. L’accès à l’API se fait uniquement via IPv4. Vous avez saisi une adresse IPv6. Utilisez plutôt l’adresse IPv4 de votre système.
- Vous avez perdu la clé. Il ne peut pas être réutilisé. Il est nécessaire de créer un nouveau hub, d’installer votre système dessus, puis de supprimer l’ancien hub. Si votre hub dispose déjà de deux hubs de ce type, il est préférable de supprimer d’abord l’ancien hub. Votre système ne pourra pas communiquer avec le hub tant que vous n’aurez pas l’ancienne clé.