Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API de l’opérateur

Tout ce que fait le portail passe par l’API publique : revendeurs, clients, numéros, grilles, trunks, diagnostic et réglages de l’instance s’automatisent avec une clé d’API de votre organisation.

Clés d’API

Menu API (admin opérateur, admin revendeur) : donnez à la clé un usage (« Supervision »), un rôle de votre organisation et, si vous voulez, une date d’expiration, puis Créer la clé. Copiez-la tout de suite : elle ne sera plus affichée. Une clé n’a jamais plus de droits que vous, et seule une personne connectée crée ou révoque une clé. Révoquer coupe l’accès de l’outil qui l’utilise. Les clients ont la même page dans leur espace.

Webhook du parc

Votre outil (supervision, CRM, facturation) reçoit les événements de votre parc à une adresse https, signés par un secret affiché une fois : cdr.month (appels du mois écoulé), client.created, extension.created, trunk.down, trunk.up. Le corps JSON porte l’événement, son instant et l’identifiant du client (customer_id). Les derniers envois et leur état s’affichent sous le réglage. Un revendeur a le même réglage pour ses clients.

Supervision

La carte Supervision (Prometheus) de la même page crée le jeton qui ouvre /metrics à votre Prometheus : voir Supervision.

Documentation

Deux documentations sont servies par le centrex :

  • la complète, pour vous et vos revendeurs : /api/docs/operateur (/api/docs/operateur/en en anglais ; description OpenAPI : /api/v1/openapi.json et /api/v1/openapi.en.json) ;
  • celle de l’espace client, que vos clients voient : /api/docs (description /api/v1/openapi-client.json), limitée à leurs propres opérations.

Le serveur MCP (/api/v1/mcp) expose les mêmes opérations, avec les droits de la clé utilisée : voir Assistants IA (MCP). Une erreur porte un code stable et un detail ; avec l’en-tête Accept-Language: en, le detail est en anglais. Chaque clé peut envoyer 300 requêtes d’affilée, puis 10 par seconde ; au-delà, la réponse est 429 (trop_de_requetes) avec Retry-After.