Ouvrir l’API système
Cette page est destinée à l’administrateur de l’installation. Ouvrez Système → API de l’installation. Les rubriques Jetons et Documentation concernent l’ensemble de l’installation. Un accès client ordinaire ne suffit pas : l’écran vérifie la capacité à administrer le PBX et affiche un refus si aucun onglet n’est accessible.
Créer un accès à l’installation
| Champ | À quoi ça sert | Valeurs possibles | Exemple |
|---|---|---|---|
| Nom | Reconnaître le consommateur ; obligatoire | Texte, 120 caractères au maximum | Supervision centrale |
| Expiration (facultative) | Fixer la fin d’utilisation | Date et heure | Fin de maintenance |
| Adresses IP ou réseaux autorisés (facultatifs) | Limiter les origines | Adresses ou réseaux reconnus par le serveur | Réseau d’administration |
| Accès | Choisir la portée des opérations | Lecture seule au départ ; Lecture et écriture | Lecture seule |
- Dans Jetons, cliquez sur Créer un jeton. Remplissez le dialogue puis validez avec Créer un jeton.
- Copiez le secret avec Copier et conservez-le avant J’ai conservé la clé.
- Consultez son état et sa dernière utilisation dans la liste.
- Pour remplacer la clé, utilisez Renouveler la clé, confirmez le renouvellement puis actualisez l’application qui l’emploie.
- Pour couper l’accès, ouvrez le menu …, choisissez Révoquer, relisez le nom, puis confirmez. Annuler conserve le jeton.
Ces jetons donnent accès à toute l’installation. Leur portée n’est pas limitée au client affiché dans le sélecteur de la console.
La date d’expiration est saisie dans le fuseau indiqué sous le champ. Vérifiez l’heure avant de créer le jeton. Annuler ferme une confirmation sans renouveler ni révoquer la clé.
Consulter et vérifier
La rubrique Documentation propose la recherche des routes, leurs paramètres, les schémas et Télécharger OpenAPI. Pour Essayer, saisissez une clé et les paramètres obligatoires. Les opérations autres que la lecture demandent confirmation avant leur exécution réelle. Lisez la réponse avant toute nouvelle tentative.
Une erreur de chargement ne signifie pas que la liste de jetons est vide. Reprenez la lecture avec la commande de reprise affichée. En cas de refus, utilisez un compte autorisé à administrer l’installation. Les détails de la saisie et des essais sont expliqués dans API du client.