Saltar al contenido
Desarrolladores

Conecta Xat CRM con lo que ya usas.

Una API REST y webhooks salientes para integrar tus conversaciones, contactos y mensajes con tus propios sistemas.

endpoints
29
permisos
16
eventos
9

Cómo funciona

La API vive en su propio dominio y se autentica con claves que tú creas desde tu espacio de trabajo. Cada clave lleva solo los permisos que le concedas.

URL base
https://api.xatcrm.com/public/v1

Todos los endpoints cuelgan de esta ruta.

Autenticación

Cada petición lleva una clave de API en la cabecera Authorization. También se acepta la cabecera alternativa si tu cliente no permite enviar Authorization.

Authorization: Bearer xat_live_…

Las claves se crean desde Ajustes → Claves de API en tu espacio de trabajo. La clave completa se muestra una sola vez, al crearla: después solo se guarda su huella, así que no podemos recuperarla por ti.

X-Xat-Api-Key

Permisos

Los permisos se conceden explícitamente. Una clave solo puede llamar a los endpoints cuyo permiso tenga, y conceder escritura no concede lectura.

RecursoPermisos disponibles
contacts
contacts:readcontacts:write
conversations
conversations:readconversations:write
messages
messages:readmessages:write
inboxes
inboxes:read
labels
labels:readlabels:write
assignments
assignments:readassignments:write
attachments
attachments:readattachments:write
notes
notes:readnotes:write
quickreplies
quickreplies:read

Límites de uso

Los límites se aplican por clave. Cada respuesta incluye cabeceras con tu consumo actual, para que puedas reducir el ritmo antes de agotarlo.

General
600/min
Envío de mensajes
60/min
Cabeceras de respuesta
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset

Idempotencia

Las operaciones de escritura aceptan una clave de idempotencia. Si repites la misma petición con la misma clave —porque se cayó la red o tu proceso reintentó— obtienes el resultado original en vez de una segunda escritura.

Paginación

Los listados paginan por cursor. Cada respuesta indica cómo pedir la página siguiente; no hay números de página que se desplacen cuando llegan datos nuevos.

Errores

Los errores llegan con un código estable dentro de un sobre uniforme. El código es el contrato: el mensaje puede cambiar, el código no.

¿Listo para integrar?

Crea tu espacio de trabajo y genera tu primera clave de API.