Accès API et documentation de l’API

À quoi cela sert

Un compte API est une paire de clés composée d’une clé API et d’un secret API avec lesquels un système tiers se connecte à l’interface d’EasyUC, par exemple un système de tickets ou un système de gestion des identités qui fait créer automatiquement des utilisateurs et des téléphones.

La page API Documentation présente les interfaces de cette installation précise dans une interface Swagger : endpoints, paramètres, réponses. Elle est divisée en domaines : default, devices, users, groups, reporting, curri, templates, voicemails et globals.

Prérequis

• Un compte ayant le type d’accès Administrator (full access) (ROLE_APP_ADMIN) ou le compte propriétaire (ROLE_OWNER). Seuls ces comptes voient le menu Administration.
• Un lieu de stockage sécurisé pour le secret, par exemple un coffre-fort de mots de passe.
• La finalité de chaque compte API est définie. Créez un compte distinct pour chaque système tiers afin de pouvoir le révoquer individuellement.

Procédure pas à pas : générer un compte API

1. Ouvrez l’espace de travail EasyUC Cisco.
2. Sélectionnez Administration → Integrations & Communication → API Access. La page s’intitule Manage API Users.
3. Cliquez sur Create en haut à droite. EasyUC crée immédiatement le compte, sans autre formulaire.
4. Une fenêtre de notification avec Api key et Api secret apparaît. Copiez les deux valeurs dans votre coffre-fort de mots de passe.
5. Fermez la fenêtre avec Ok. La liste n’affiche ensuite que l’API Key.
6. Saisissez la clé et le secret dans le système tiers.

Procédure pas à pas : consulter une interface

1. Sélectionnez Administration → Integrations & Communication → API Documentation.
2. Dans la liste de sélection des définitions en haut, sélectionnez le domaine, par exemple users ou devices.
3. Développez l’endpoint souhaité et lisez les paramètres, les exemples de corps de requête et les codes de réponse.
4. Faites attention au paramètre de la connexion CUCM. De nombreux appels se rapportent à un seul cluster précis.

Procédure pas à pas : révoquer un compte API

1. Déterminez quel système tiers utilise la clé.
2. Cliquez sur Delete dans la ligne de la clé.
3. Confirmez la demande Are you sure?. Le compte est invalide immédiatement.

Champs et options

Vérifier le résultat et circonscrire les erreurs

• Réussite : le système tiers se connecte avec la clé et le secret et reçoit des réponses à ses appels.
• Le secret est perdu : supprimez le compte et générez-en un nouveau. Un secret ne peut pas être affiché de nouveau.
• La connexion est temporairement refusée après plusieurs tentatives échouées : EasyUC ralentit les connexions échouées répétées. Corrigez les identifiants et patientez quelques minutes.
• La documentation de l’API reste vide : elle n’est accessible qu’aux utilisateurs connectés. Reconnectez-vous et rechargez la page.
• Utilisez les endpoints et les noms de champs de la documentation de votre propre installation, pas ceux d’une autre version.
• L’audit log connaît le type d’acteur API user. Vous pouvez y retracer ce qui a été modifié via un compte API.