La API de Totem permite que tu servidor lea los datos del CRM de tus equipos de Totem: los leads con su posición en el embudo, su origen y sus permisos de contacto, lo que le ha pasado a cada lead, las llamadas, las conversaciones y las citas. Con ella puedes:
- Exportar tu CRM a otro CRM, o a archivos y tablas que controles.
- Alimentar una herramienta de BI o un almacén de datos, y analizar leads, llamadas y citas junto al resto de tu negocio.
- Automatizar el seguimiento en tus propios sistemas, por ejemplo cuando un lead llega a una etapa, respetando siempre los permisos de contacto de cada lead.
El Inicio rápido te lleva de una clave nueva a tus primeros leads en cuatro pasos.
Qué es la versión 1.0a
- Solo lectura. Ningún endpoint crea ni modifica nada en Totem.
- Beta. Disponible para los clientes de Totem que cumplen los requisitos. Crea una clave en Ajustes → Desarrolladores; no necesitas invitación. En Convenciones se explica qué puede cambiar durante la Beta.
- Datos de contacto, sin contenido. La API devuelve datos de contacto, como nombres, correos electrónicos y teléfonos, y los metadatos del CRM: etapas, llamadas, conversaciones y citas. Nunca devuelve el texto de los mensajes, las transcripciones de llamadas, los resúmenes, las grabaciones, las notas, las respuestas de texto libre ni los campos personalizados de los formularios. Trata cada respuesta como datos personales.
- Consulta periódica, sin webhooks. La copia se mantiene al día leyendo el feed de cambios cada 1 a 5 minutos. El registro de cambios anuncia cualquier capacidad nueva.
- Acceso de administrador. Una clave lee todo lo que puede leer un administrador de sus equipos, incluidos los canales y los registros marcados como privados. El administrador que crea la clave lo confirma expresamente.
Qué puedes leer
Todas las peticiones van a https://api.totemstudio.ai/v1 por HTTPS, y la API responde en JSON.
| Datos | Endpoints |
|---|---|
| Tu integración y sus equipos | GET /v1/me, GET /v1/teams, GET /v1/teams/{id} |
| Miembros del equipo | GET /v1/members |
| Tableros, con sus etapas | GET /v1/boards |
| Leads, con su atribución y su respuesta | GET /v1/leads, GET /v1/leads/{id}, POST /v1/leads/search |
| Lo que le ha pasado a un lead | GET /v1/leads/{id}/activities |
| Llamadas | GET /v1/calls, GET /v1/calls/{id} |
| Conversaciones, sin sus mensajes | GET /v1/conversations, GET /v1/conversations/{id} |
| Servicios reservables | GET /v1/booking_services |
| Citas | GET /v1/bookings, GET /v1/bookings/{id} |
| Todos los cambios, equipo por equipo | GET /v1/sync/changes |
| Si la API está disponible | GET /v1/health |
Antes de empezar a construir
- Guarda la clave en tu servidor. Nunca la pongas en un navegador, en una app móvil ni en un repositorio público. En Autenticación se explica dónde puede guardarse.
- Aplica primero los permisos de contacto. Copia los
contact_permissionsde cada lead antes de que cualquiera de tus sistemas contacte con esa persona. - Aplica las eliminaciones. Cuando el feed de cambios elimine un registro, bórralo cuanto antes de todos los sistemas a los que lo copiaste.
- Protege lo que copias. En Seguridad y datos personales se explica qué protege Totem y qué hacer con los datos personales que recibes.
- Haz las pruebas con datos ficticios. En Pruebas y puesta en producción se explica cómo.
Siguientes pasos
- Inicio rápido: haz tus primeras peticiones.
- Sincroniza una copia: copia un equipo con el feed de cambios y mantén la copia al día, a partir de un receptor probado.
- Autenticación: las claves, los equipos y la cabecera
Totem-Team. - Errores: qué significa cada código de error y qué hacer.
- Convenciones: las reglas que siguen todas las respuestas, antes de la referencia de los endpoints.
- Seguridad y datos personales: las claves, los registros de actividad, dónde funciona la API y cómo tratar los datos que copias.