Usar la API y los SDK de Ody
Cada plan de Ody incluye la API REST pública. Crea una clave en la aplicación, luego llama a la API directamente o instala un SDK oficial. La referencia completa, las guías y los ejemplos se encuentran en el sitio para desarrolladores — dev.ody.co — no en este centro de ayuda.
Crear una clave API
Debes ser administrador del espacio de trabajo o el propietario.
- Abre Configuración → API para desarrolladores (en un teléfono: Más → Configuración → API para desarrolladores).
- Escribe un Nombre de clave (por ejemplo, "Zapier" o "Servidor de producción").
- Deja todos los ámbitos seleccionados para acceso completo, o deselecciona ámbitos para limitar la clave (por ejemplo, una clave de solo lectura para un asistente de IA).
- En Tipo de clave, elige Live o Test.
- Haz clic en Crear clave.
- Copia el secreto del banner "Copia tu nueva clave ahora, no la volverás a ver." Ody solo almacena un hash; si pierdes el secreto, revoca la clave y crea una nueva.
La lista de claves muestra una pista enmascarada (ody_live_…WXYZ o ody_test_…WXYZ), una insignia de Test para las claves de prueba, los ámbitos y cuándo se usó la clave por última vez. Haz clic en Revocar para deshabilitar una clave inmediatamente.
Instalar un SDK
Los clientes oficiales sin dependencias envuelven la misma API REST, con paginación automática, errores tipados, envíos idempotentes y verificación de Webhooks Estándar:
| Idioma | Instalar | Documentación |
|---|---|---|
| TypeScript / JavaScript | npm install @ody-co/sdk |
dev.ody.co/sdks/typescript |
| Python | pip install ody-sdk (importar como ody) |
dev.ody.co/sdks/python |
Comienza con la descripción general del SDK o la guía de inicio rápido de 5 minutos. ¿Prefieres HTTP simple? Cada ejemplo en el sitio para desarrolladores tiene una pestaña cURL, y la especificación OpenAPI legible por máquina está en api.ody.co/v1/api/openapi.json.
Qué más hay en el sitio para desarrolladores
| Tema | Enlace |
|---|---|
| Autenticación, ámbitos, Live vs Test | Autenticación |
| Referencia de la API REST | Descripción general de la API |
| Webhooks salientes (verificar firmas, catálogo de eventos) | Webhooks |
| Conectar ChatGPT o Claude a través de MCP | MCP |
| Switchboard (planificar y construir enrutamiento de llamadas con IA) | Switchboard |
La misma clave API alimenta REST, los SDK y el servidor MCP. Pega una clave en un cliente MCP con el punto final que se muestra en Conectar a ChatGPT y Claude en la pantalla API para desarrolladores.
Solución de problemas
- "No se pudo crear la clave API" — necesitas ser administrador o propietario del espacio de trabajo. Pide al propietario que te ascienda, o que cree la clave por ti.
- Se perdió el secreto — no puedes recuperarlo. Revoca la clave en Configuración → API para desarrolladores y crea una nueva.
- 401 / no autorizado desde tu código — verifica que la clave sea Live o Test según lo previsto, que no haya sido revocada y que el encabezado
Authorization: Bearer …use el secreto completo (incluido el prefijoody_live_oody_test_). - 403 ámbito faltante — la clave se creó con un conjunto reducido de ámbitos. Crea una nueva clave con los ámbitos que tu punto final necesita, o consulta Ámbitos.
- ¿Quieres Zapier / Make en lugar de código? — muchas herramientas sin código llaman a la API REST con la misma clave; consulta la descripción general de la API. Las conexiones integradas de CRM y mesa de ayuda se encuentran en ¿Qué integraciones soporta Ody?.
Artículos relacionados
Preguntas frecuentes
¿Dónde está la documentación para desarrolladores?
Todo para los desarrolladores se encuentra en https://dev.ody.co — API REST, webhooks, MCP, Switchboard y los SDK de TypeScript y Python. El centro de ayuda solo cubre cómo crear tu clave API en la aplicación.
¿Cómo instalo el SDK de Ody?
TypeScript/JavaScript: npm install @ody-co/sdk. Python: pip install ody-sdk (importar como ody). Ambos están en v0.6.0, sin dependencias e incluyen verificación de webhook.
¿Quién puede crear una clave API?
Un administrador del espacio de trabajo o el propietario. Abre **Configuración → API para desarrolladores** (en un teléfono: **Más → Configuración → API para desarrolladores**).
¿Cuál es la diferencia entre las claves Live y Test?
Las claves Live (ody_live_…) envían mensajes de texto reales y realizan llamadas reales. Las claves Test (ody_test_…) leen y escriben datos reales del espacio de trabajo, pero nunca envían mensajes de texto reales; los envíos se registran como simulados. Usa Test mientras desarrollas.