Référence de l’API pour les développeurs
Connecter votre propre application à votre espace de travail : l’API REST, ses clés et portées, les erreurs, les limites de débit et les webhooks.
Où le trouver
⚙️ Paramètres › Référence de l'API · Page d’accueil › Ressources › Référence de l'API
Ouvrir cet écran
Étapes
- Ouvrez “Référence de l'API” dans la barre latérale, ou “Référence de l'API” dans le menu “Ressources” de la page d’accueil.
- Commencez par “Pour commencer” : “URL de base et conventions”, “Authentification” et “Portées”.
- Consultez les “Points de terminaison” par groupe ; chacun montre ses paramètres, le corps de requête, la réponse et les erreurs avec des exemples.
- Lisez “Erreurs et codes d'état”, “Limites de débit” et “Webhooks (sortants)” avant la mise en production. “OpenAPI JSON” télécharge la spécification complète.
Dépannage
Comment obtenir une clé d’API ?
Les clés sont émises pour votre espace de travail sur demande ; elles ne peuvent pas encore être créées dans l’application. Les clés de votre espace de travail sont listées sur la page développeur de l’espace IA, où les personnes qui gèrent l’espace de travail peuvent aussi ajouter et tester des points d’entrée webhook.
Astuces
- Appelez l’API uniquement depuis votre serveur. Ne mettez jamais une clé dans une page web ou une application mobile.
Bon à savoir
- La référence de l’API se lit sans connexion.
Guides pratiques associés
- Comment trouver un point de terminaison et copier un exemple ? Rechercher dans la référence de l’API, aller à un point de terminaison et copier son exemple ou son lien.
- Comment lire les questions fréquentes (Documentation) ? Lire des réponses courtes sur ce que fait le produit aujourd’hui : démarrage, langues et voix, appels de test, numéros de téléphone, forfaits et compte.
- Fonctionnalités Le catalogue complet des fonctionnalités de centre d’appels, chacune marquée honnêtement comme livrée ou prévue.