Skip to main content
La API de Yampi.ai está organizada en cuatro grupos principales: Platform, Application, Client y Others. La URL base es https://app.yampi.ai.

​
Estructura de la API

Platform API

Endpoints para provisionar cuentas, usuarios y bots a nivel de plataforma (/platform/api/v1/).

Application API

Operación diaria: contactos, conversaciones, inboxes, treasury, propiedades, compañías, oportunidades, contratos, Captain, SLA, etc. (/api/v1/).

Client API (pública)

Endpoints públicos para frontends: Contacts, Conversations y Messages API (/public/api/v1/).

Others

Encuestas CSAT y otros endpoints (/survey/).

​
Base URL

Todas las rutas documentadas se construyen sobre: 
https://app.yampi.ai

​
Autenticación

Los endpoints usan el header api_access_token con uno de estos esquemas:
  • userApiKey: token de usuario (perfil)
  • agentBotApiKey: token para bots (acceso limitado)
  • platformAppApiKey: token de aplicación de plataforma (provisioning)

Autenticación

Ver ejemplos, tipos de token y mejores prácticas.

Completitud de la documentación

Estado actual: 100% de las operaciones del OpenAPI tienen página dedicada (167/167).