Clara API — Documentación MX
|
🔌 Desarrolladores · API
La Clara API te da control programático
completo sobre la gestión de gastos corporativos: emite y administra tarjetas,
consulta transacciones, gestiona usuarios, procesa facturas y genera reportes
de conciliación, todo a través de una interfaz REST con cuerpos en JSON.
|
🛠️ ¿Qué puedes construir con Clara API?
| Módulo |
¿Qué puedes hacer? |
| 💳 Tarjetas |
Emite tarjetas físicas y virtuales, establece límites de gasto, bloquea/desbloquea y configura restricciones por comercio, horario o categoría. |
| 📊 Transacciones |
Lista, filtra y exporta transacciones con datos completos de comercio, usuario, etiquetas y contabilidad. |
| 👥 Usuarios |
Crea, actualiza y desactiva usuarios. Administra roles, centros de costo y asignaciones de manager. |
| 🧾 Facturas y CFDI |
Consulta facturas fiscales CFDI y documentos vinculados a transacciones. Solo México
|
| 📋 Conciliación |
Accede a estados de cuenta mensuales con detalle de transacciones para conciliación automatizada con tu ERP. |
| 💸 Reembolsos |
Consulta y administra registros de reembolsos de empleados por fecha, estatus o solicitante. |
| 💳 Tarjetas Virtuales (VCN) |
Genera y administra Virtual Card Numbers para compras B2B controladas con reglas de gasto específicas. |
| 🤖 Clara MCP |
Conecta Claude, ChatGPT, Gemini o cualquier asistente de IA compatible con MCP directamente a los datos de Clara. |
URL base
Todas las solicitudes para cuentas de México deben dirigirse a:
|
🇲🇽 México
https://public-api.mx.clara.com
|
Versiones disponibles
| Versión |
Estado |
Recomendación |
| v3 |
Actual |
Usa esta versión para todas las integraciones nuevas. |
| v2 |
Estable |
Soportada, no deprecada. Puedes seguir usándola. |
| v1 |
Legacy |
Evitar para desarrollos nuevos. |
Autenticación: mTLS + OAuth 2.0
Cada solicitud requiere dos capas de autenticación:
| # |
Capa |
¿Qué es? |
| 1 |
Mutual TLS (mTLS) |
Certificado X.509 de cliente válido en cada solicitud. Clara te provee el certificado público, privado y el de la autoridad certificadora al activar tu acceso. |
| 2 |
Bearer Token (OAuth 2.0) |
JWT obtenido desde el endpoint de Auth0 usando tu Client ID y Client Secret. Inclúyelo en todas las solicitudes:
Authorization: Bearer <token>
|
|
💡 Solo los usuarios con rol de Owner pueden generar y administrar las credenciales de la Clara API.
|
Métodos y alcances disponibles
| Entidad |
Permisos |
| Transacciones |
Lectura Escritura
|
| Usuarios |
Lectura Escritura
|
| Tarjetas |
Lectura Escritura
|
| Grupos |
Lectura Escritura
|
| Locaciones |
Lectura |
| Adjuntos |
Lectura |
| Pagos |
Lectura Escritura
|
Códigos de respuesta
| Código |
Significado |
| 200 |
Solicitud exitosa. |
| 400 |
Solicitud inválida — parámetros incorrectos o campos requeridos faltantes. |
| 401 |
No autorizado — Bearer token ausente o inválido. |
| 403 |
Prohibido — token válido pero permisos insuficientes. |
| 404 |
Recurso no encontrado. |
| 429 |
Límite de solicitudes excedido — aplica backoff exponencial y reintenta. |
| 500 |
Error interno del servidor. |
📚 Documentación técnica y acceso
|
📖 Documentación oficial Clara API
🔗 Ir a la documentación
Referencia completa de endpoints, guías de integración, ejemplos de código y documentación del sandbox.
|
|
💡 Para solicitar tus credenciales de acceso, escríbenos a
contacto@clara.com
indicando el nombre de tu empresa y el equipo de desarrollo responsable de la integración.
|
Comentarios
Inicie sesión para dejar un comentario.