Clara API: Integración y Automatización de la Gestión Empresarial

La Clara API te permite consultar e interactuar con la información clave que reside en tu plataforma Clara, incluyendo transacciones, usuarios, tarjetas y más. Es la herramienta ideal para desarrolladores que buscan automatizar la gestión de gastos e integrarla con sus sistemas internos.

Principios de Diseño

Nuestra API está diseñada y construida siguiendo los principios REST (Representational State Transfer), garantizando la simplicidad y la previsibilidad en el desarrollo de aplicaciones. Al contemplar los estándares HTTP, la API de Clara es compatible con una amplia gama de clientes HTTP, incluidos lenguajes de programación y entornos de trabajo.

Métodos y Alcances Disponibles

La API está organizada en torno a entidades empresariales clave, cada una con permisos de acceso específicos (lectura o escritura):

La API de Clara permite consultar las transacciones, usuarios, tarjetas e información adicional que se encuentra en La Plataforma Clara.

Nuestra API está diseñada y construida siguiendo los principios REST (Representational State Transfer), lo que garantiza la simplicidad en el desarrollo de aplicaciones.

Esta API contempla los estándares HTTP, lo que garantiza la compatibilidad con una amplia gama de clientes HTTP. Pueden ser utilizados varios clientes HTTP, incluidos lenguajes de programación y entornos de trabajo, para interactuar sin problemas con nuestra API.

¿Cuáles son los métodos y alcances disponibles en la API de Clara?

• Transacciones: Lectura/Escritura

• Usuarios: Lectura/Escritura

• Tarjetas: Lectura/Escritura

• Grupos: Lectura/Escritura

• Locaciones: Lectura

• Adjuntos: Lectura

• Pagos: Lectura/Escritura

Autenticación Segura (OAuth 2.0 y mTLS)

La Clara API incorpora un mecanismo de autenticación sólido que utiliza OAuth 2.0 junto con mTLS (mutual Transport Layer Security). Esto garantiza un acceso seguro a la API y protege sus datos más valiosos.

El proceso de autenticación involucra los siguientes pasos esenciales para desarrolladores:

Aplicar estilo rounded.

1. Registro de Cliente: Antes de acceder a la API, debes registrar tu aplicación cliente, proporcionando los detalles de configuración necesarios para la autenticación.

2. Usuario y Autoridades: Una vez registrada la aplicación de cliente, puedes crear usuarios dentro del proyecto y asignar autoridades específicas para administrar los privilegios de acceso en función de las diferentes funciones.

3. Adquisición de Token: Para autenticar tus solicitudes, debes obtener un token a través de nuestra integración Auth0. Mediante la respuesta podrás recuperar el ID del token, el cual sirve como clave para las solicitudes posteriores.

4. Configuración de Certificado: Es esencial establecer una conexión segura configurando tu aplicación cliente con los certificados generados (claves públicas y privadas). Estos certificados permiten la autenticación mutua (mTLS), reforzando la seguridad del canal de comunicación.

5. Flujo de Autenticación: Utiliza la identificación del cliente (Client ID), el secreto del cliente (Client Secret) y los parámetros de inicio de sesión requeridos para realizar una solicitud a un Endpoint de autenticación, siguiendo el flujo de OAuth 2.0.

6. Recuperación Segura de Datos: Una vez que hayas obtenido el token de acceso, puedes recuperar datos de forma segura desde la API de Clara. Realiza solicitudes HTTP (como GET) a los Endpoints de la API. Recuerda incluir el token de acceso como un token portador en el encabezado (header) de la solicitud para autorizar tu acceso.