Saltar al contenido principal
La API de Ciarem te permite conectar Ciarem con tus propios sistemas: sincronizar contactos, gestionar tus propiedades de CRM y etapas del embudo, y leer conversaciones de forma programática. Está disponible en los planes Growth y Scale, y durante la prueba gratuita para que la pruebes antes de pagar.
No necesitas la API para usar Ciarem. Todo en el producto funciona sin escribir código. Recurre a la API cuando quieras integrar Ciarem con herramientas que no conectamos de forma nativa.

​
1. Crea una clave de API

Necesitas ser administrador, en un plan Growth o Scale, o en la prueba gratuita.
1

Abre Claves de API

En el panel, ve a Configuración y luego a Claves de API.
2

Haz clic en Crear clave

Ponle un nombre que indique para qué integración es.
3

Copia el secreto

El secreto empieza con oak_ y se muestra solo una vez: cópialo de inmediato y guárdalo como una contraseña. Si lo pierdes, revoca la clave y crea una nueva.

​
2. Haz tu primera solicitud

Cada solicitud se autentica con la clave como token bearer:
Una respuesta exitosa identifica la organización a la que pertenece la clave:

​
3. Explora

  • Crea y actualiza contactos, incluidas tus propiedades personalizadas: consulta la referencia de la API.
  • Lee conversaciones y mensajes. Cada mensaje te dice quién habló: el campo sender es contact, agent, ai o system.
  • Gestiona los metadatos del CRM: propiedades personalizadas y etapas del embudo, las mismas que tu equipo usa en el panel.
  • Recibe webhooks: haz que Ciarem llame a tu servidor cuando cambia un contacto, una conversación o un mensaje, en vez de consultar una y otra vez. Consulta Webhooks.
Continúa con Autenticación y Errores, límites y paginación.