Utiliser l'API et les SDK Ody
Chaque forfait Ody inclut l'API REST publique. Créez une clé dans l'application, puis appelez l'API directement ou installez un SDK officiel. La référence complète, les guides et les exemples se trouvent sur le site des développeurs — dev.ody.co — et non dans ce centre d'aide.
Créer une clé API
Vous devez être un administrateur de l'espace de travail ou le propriétaire.
- Ouvrez Réglages → API Développeur (sur un téléphone : Plus → Réglages → API Développeur).
- Saisissez un Nom de clé (par exemple "Zapier" ou "Serveur de production").
- Laissez toutes les portées sélectionnées pour un accès complet, ou désélectionnez des portées pour limiter la clé (par exemple, une clé en lecture seule pour un assistant IA).
- Sous Type de clé, choisissez Live ou Test.
- Cliquez sur Créer une clé.
- Copiez le secret de la bannière "Copiez votre nouvelle clé maintenant — vous ne la reverrez plus." Ody ne stocke qu'un hachage — si vous perdez le secret, révoquez la clé et créez-en une nouvelle.
La liste des clés affiche un indice masqué (ody_live_…WXYZ ou ody_test_…WXYZ), un badge Test pour les clés de test, les portées, et la date de dernière utilisation de la clé. Cliquez sur Révoquer pour désactiver une clé immédiatement.
Installer un SDK
Les clients officiels sans dépendances encapsulent la même API REST, avec pagination automatique, erreurs typées, envois idempotents et vérification des Webhooks Standards :
| Langage | Installation | Docs |
|---|---|---|
| TypeScript / JavaScript | npm install @ody-co/sdk |
dev.ody.co/sdks/typescript |
| Python | pip install ody-sdk (importer sous le nom ody) |
dev.ody.co/sdks/python |
Commencez par l'aperçu du SDK ou le guide de démarrage rapide en 5 minutes. Vous préférez le HTTP simple ? Chaque exemple sur le site des développeurs dispose d'un onglet cURL, et la spécification OpenAPI lisible par machine se trouve à l'adresse api.ody.co/v1/api/openapi.json.
Ce que vous trouverez d'autre sur le site des développeurs
| Sujet | Lien |
|---|---|
| Authentification, portées, Live vs Test | Authentification |
| Référence de l'API REST | Aperçu de l'API |
| Webhooks sortants (vérifier les signatures, catalogue d'événements) | Webhooks |
| Connecter ChatGPT ou Claude via MCP | MCP |
| Switchboard (planifier et construire le routage d'appels avec l'IA) | Switchboard |
La même clé API alimente REST, les SDK et le serveur MCP. Collez une clé dans un client MCP avec le point de terminaison affiché sous Connecter à ChatGPT & Claude sur l'écran API Développeur.
Dépannage
- "Impossible de créer la clé API" — vous devez être un administrateur ou le propriétaire de l'espace de travail. Demandez au propriétaire de vous promouvoir, ou demandez-lui de créer la clé.
- Secret perdu — vous ne pouvez pas le récupérer. Révoquez la clé dans Réglages → API Développeur et créez-en une nouvelle.
- 401 / non autorisé depuis votre code — vérifiez que la clé est Live ou Test comme prévu, qu'elle n'a pas été révoquée, et que l'en-tête
Authorization: Bearer …utilise le secret complet (y compris le préfixeody_live_ouody_test_). - 403 portée manquante — la clé a été créée avec un ensemble de portées restreint. Créez une nouvelle clé avec les portées dont votre point de terminaison a besoin, ou consultez Portées.
- Vous préférez Zapier / Make au lieu du code — de nombreux outils sans code appellent l'API REST avec la même clé ; consultez l'aperçu de l'API. Les connexions CRM et helpdesk intégrées se trouvent sous Quelles intégrations Ody prend-il en charge ?.
Articles connexes
Questions fréquemment posées
Où se trouve la documentation pour les développeurs ?
Tout ce dont les développeurs ont besoin se trouve sur https://dev.ody.co — API REST, webhooks, MCP, Switchboard, et les SDK TypeScript et Python. Le centre d'aide ne couvre que la création de votre clé API dans l'application.
Comment installer le SDK Ody ?
TypeScript/JavaScript : npm install @ody-co/sdk. Python : pip install ody-sdk (importer sous le nom ody). Les deux sont en v0.6.0, sans dépendances, et incluent la vérification des webhooks.
Qui peut créer une clé API ?
Un administrateur de l'espace de travail ou le propriétaire. Ouvrez Réglages → API Développeur (sur un téléphone : Plus → Réglages → API Développeur).
Quelle est la différence entre les clés Live et Test ?
Les clés Live (ody_live_…) envoient de vrais SMS et passent de vrais appels. Les clés Test (ody_test_…) lisent et écrivent de vraies données d'espace de travail mais n'envoient jamais de vrais SMS — les envois sont enregistrés comme simulés. Utilisez Test pendant que vous développez.