Clara API

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
  • Usuarios: Lectura
  • Tarjetas: Lectura
  • Grupos: Lectura
  • Locaciones: Lectura

¿Qué tipo de autorización utiliza la API de Clara?

La API de Clara incorpora un sólido mecanismo de autenticación que utiliza OAuth 2.0 junto con mTLS (mutual Transport Layer Security). Esto garantiza un acceso seguro a la API y protege sus valiosos datos. El proceso de autenticación implica los siguientes pasos esenciales:

 

  • Registro de clientes: Antes de acceder a la API de Clara, debes registrar tu aplicación cliente. Durante el registro se proporciona los detalles de configuración necesarios para la autenticación.
  • Usuario y autoridades: Una vez que tu aplicación de cliente esté registrada, puedes crear usuarios dentro del proyecto y asignar autoridades específicas. Esto te permite administrar de manera efectiva los privilegios de acceso en función de las diferentes funciones de los usuarios.
  • Adquisición de Token: Para autenticar tus solicitudes a la API de Clara, debes adquirir un token. El token se obtiene creando usuarios 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.
  • Configuración del certificado: Es esencial establecer una conexión segura entre su aplicación cliente y la API de Clara. Esto se logra configurando su aplicación cliente con los certificados generados, incluidas las claves públicas y privadas. Estos certificados permiten la autenticación mutua, reforzando la seguridad del canal de comunicación.
  • Flujo de autenticación: Para iniciar el proceso de autenticación, utiliza la identificación del cliente, el secreto del cliente y cualquier otro parámetro de inicio de sesión requerido. Posteriormente, realiza una solicitud a un EndPoint de autenticación, siguiendo el flujo de OAuth 2.0. Tras una autenticación exitosa, la API emitirá un token de acceso y proporcionará las credenciales asociadas.
  • 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 de HTTP (como GET) a los EndPoints de la API. Recuerda incluir el token de acceso como un token portador en el header de la solicitud para autorizar tu acceso y garantizar la seguridad de los datos.

¿Cómo puedo acceder a la API de Clara?

Puedes contactarnos solicitando tus accesos a la API de Clara al correo contacto@clara.com, y con gusto te ayudaremos.

Los certificados que recibirás son:

  • Certificado público para el cliente
  • Certificado privado para el cliente
  • Clave de token para el usuario
  • Clave secreta del token
  • Certificado público de nuestras autoridades de certificación

¿Qué roles pueden obtener acceso a la API de Clara?

Las claves API de Clara son administradas solo por usuarios con rol de Owner

¿Fue útil este artículo?
Usuarios a los que les pareció útil: 1 de 1
¿Tiene más preguntas? Enviar una solicitud

Comentarios

0 comentarios

Inicie sesión para dejar un comentario.