Ouvrir l’API du client

Cette page s’adresse à l’administrateur qui confie un accès à une application. Sélectionnez le client, puis ouvrez API. Attendez la vérification des droits. Les onglets disponibles dépendent de vos autorisations : Jetons, Documentation, Webhooks. Sans client, l’écran demande « Choisissez un client. ».

Les anciennes entrées API et intégrations conduisent à Jetons. L’ancienne page développeurs conduit à Jetons, ou à Webhooks lorsqu’elle demandait cet onglet. Les jetons du client suivent les droits de leur créateur.

Ouvrir l’API du client, en mode clair avec données fictives ; masquer les identifiants personnels, secrets et adresses privées.

Créer et conserver un jeton

Champ À quoi ça sert Valeurs possibles Exemple
Nom Reconnaître l’application ; obligatoire Texte, 120 caractères au maximum Export quotidien
Expiration (facultative) Limiter la durée de l’accès Date et heure proposées par le champ Date de fin du projet
Adresses IP ou réseaux autorisés (facultatifs) Restreindre les origines autorisées Adresses ou réseaux, selon le contrôle du serveur Adresse de votre serveur d’intégration
Accès Limiter les opérations Lecture seule, sélectionnée au départ, ou Lecture et écriture Lecture seule
  1. Remplissez le formulaire de l’onglet Jetons.
  2. Cliquez sur Créer un jeton. Un nom vide empêche la création.
  3. Cliquez sur Copier, puis placez la clé dans le gestionnaire de secrets de votre application.
  4. Cliquez sur J’ai conservé la clé. La clé ne sera plus affichée après fermeture.

La liste indique le créateur, la création, la dernière utilisation et l’état actif, expiré ou révoqué. Renouveler la clé fournit un nouveau secret à remettre à l’application. Révoquer ouvre une confirmation portant le nom du jeton. Confirmez pour retirer son accès, ou cliquez sur Annuler. Pendant une opération, attendez la fin avant de recommencer.

Sous Jetons d’intégration, un second formulaire propose les permissions de l’intégration et sa limite de requêtes : nom obligatoire de 120 caractères au maximum, au moins une permission, limite de 1 à 600 requêtes par minute, initialement 60. La permission de lecture du journal d’appels est sélectionnée au départ. Conservez également le secret affiché après création ou renouvellement.

Lire la documentation et essayer une route

  1. Ouvrez Documentation.
  2. Utilisez Rechercher une route, puis ouvrez l’opération voulue.
  3. Lisez Paramètres, Corps de la requête, Réponses et les Schémas. Une étoile indique un paramètre obligatoire.
  4. Pour un essai, renseignez Clé pour essayer et les paramètres requis. Le champ Client cible (identifiant, facultatif) sert lorsqu’une portée explicite est nécessaire.
  5. Cliquez sur Essayer. Une opération susceptible de modifier les données demande une confirmation ; Annuler ferme cette confirmation.
  6. Lisez la réponse affichée. Télécharger OpenAPI récupère la description de l’API.

La clé d’essai reste dans cette page et disparaît lorsque vous la quittez. L’essai contacte réellement le PBX : vérifiez les valeurs avant de confirmer une écriture.

Vérifier le résultat et résoudre un refus

Vérifiez que le jeton figure dans la liste, puis que l’application utilise la nouvelle clé. Si le chargement échoue, relancez-le avec la commande de reprise affichée. Si vous voyez un refus d’accès, faites contrôler vos droits de lecture, d’écriture et de gestion des secrets : la lecture seule de la page ne suffit pas à créer un jeton.

Pour les notifications envoyées vers un autre serveur, consultez Webhooks.