Développer en toute sécurité avec le mode test

Les clés API en mode test (ody_test_…) se comportent exactement comme les clés en direct, à l'exception de tout ce qui impliquerait des dépenses ou atteindrait le monde extérieur, qui est simulé — envois de messages, achats de numéros, appels IA sortants, publication d'agents et enregistrements 10DLC (qui s'exécutent en mode simulé) — ce qui les rend parfaites pour le développement et l'intégration continue (CI).

Avant de commencer

• Vous devez être administrateur ou propriétaire de l'espace de travail pour créer des clés.
• Sachez ce que le mode test isole et n'isole pas : une clé de test fonctionne avec vos données d'espace de travail réelles. Les créations, mises à jour et suppressions de contacts sont réelles, les changements de statut de conversation sont réels, et les sauvegardes de brouillons d'agents (PATCH /v1/api/agent) sont réelles. Ce qui est simulé, ce sont les dépenses : envois, achats de numéros, appels IA sortants, publication d'agents et dépôts 10DLC.

Étape par étape

1. Cliquez sur Paramètres dans la barre latérale, puis sur API développeur.

2. Remplissez le formulaire de création comme d'habitude — nom et étendues (voir Obtenir votre clé API Ody).

3. Sous Type de clé, sélectionnez Test. L'indice le confirme : les clés de test lisent des données réelles mais n'envoient jamais de vrais SMS — les envois sont enregistrés comme simulés.

4. Cliquez sur Créer une clé et copiez le secret ody_test_… de la bannière unique.

5. Utilisez-la exactement comme une clé en direct — même URL de base, mêmes points de terminaison, étendues et limites de débit :

curl https://api.ody.co/v1/api/messages \
  -H "Authorization: Bearer ody_test_…" \
  -H "Content-Type: application/json" \
  -d '{"to":"+15125550123","body":"CI smoke test"}'

La réponse est un 201 normal avec "simulated": true, et le message apparaît dans le fil de discussion avec deliveryStatus: "simulated".

Ce qui est identique, ce qui est simulé

Comportement	Avec une clé ody_test_…
Lecture des contacts, conversations, appels, numéros	Données réelles, identique au mode en direct
Création/mise à jour/suppression de contacts	Réel — modifie votre espace de travail
Définition du statut de conversation	Réel
POST /v1/api/messages / MCP send_message	Simulé — enregistré, jamais transmis
POST /v1/api/numbers / MCP buy_number	Simulé — "simulated": true, rien n'est commandé, provisionné ou facturé
POST /v1/api/calls / MCP place_call	Simulé — un ID d'appel sim_…, rien n'est composé, aucun crédit n'est utilisé
POST /v1/api/agent/publish	Simulé — votre configuration reste un brouillon, rien n'est mis en ligne
PATCH /v1/api/agent (sauvegardes de brouillons)	Réel — identique au mode en direct
POST /v1/api/messaging/registration	Mode simulé — le pipeline 10DLC complet s'exécute, mais rien n'est soumis au registre et il n'y a pas de frais
Étendues, limites de débit, erreurs, pagination, idempotence	Identique au mode en direct
Gestion des points de terminaison de webhook	Points de terminaison réels, identique au mode en direct

Dans la liste des clés, les clés de test affichent un badge Test et un indice ody_test_…WXYZ afin que vous ne puissiez pas les confondre avec les clés en direct.

Utilisation du mode test en CI

• Créez une clé de test dédiée par pipeline (par exemple "GitHub Actions") afin de pouvoir la révoquer indépendamment et que la colonne "dernière utilisation" reste pertinente.
• Stockez-la comme un secret CI (par exemple ODY_API_KEY) — votre code ne change pas entre les environnements, seule la clé.
• Affirmez simulated: true dans les réponses d'envoi pour détecter une clé en direct accidentellement configurée en CI.
• N'oubliez pas que les écritures de contacts sont réelles : dirigez la CI vers un espace de travail dédié, ou nettoyez les contacts créés par vos tests.

Articles connexes

• Obtenir votre clé API Ody
• Présentation de l'API et authentification
• Connecter des outils IA avec MCP
• Démarrage rapide du SDK : TypeScript et Python