Documentación API

Descripción General de la API

Bienvenido a la documentación de las API de IUNI. Aquí encontrarás toda la información necesaria para integrar nuestras soluciones y servicios de manera eficiente y sencilla.

¿Qué es IUNI?

IUNI es una plataforma tecnológica de soluciones financieras que centraliza y facilita tus operaciones de forma digital. A través de nuestras API, puedes implementar funcionalidades seguras y escalables en tus aplicaciones, mejorando la experiencia del usuario y optimizando los procesos operativos.

Funcionalidades principales:

  • Gestión de Usuarios: Crea, autentica y administra usuarios de la plataforma, así como sus credenciales.
  • Administración de Clientes: Registra, actualiza y gestiona clientes individuales o comerciales.
  • Gestión de Cuentas: Añade cuentas bancarias propias o de terceros para realizar transacciones.
  • Realización de Transacciones: Ejecuta transacciones, incluyendo la dispersión de pagos a múltiples cuentas o entre diferentes usuarios, asegurando un proceso transparente y seguro.

¿Qué encontrarás en esta documentación?

Esta guía incluye ejemplos detallados, esquemas de respuesta y prácticas recomendadas para aprovechar al máximo las API de IUNI. Aquí encontrarás:
  • Instrucciones detalladas sobre cómo realizar la integración desde cero.
  • Ejemplos claros de cada endpoint.
  • Soluciones para errores y dudas frecuentes.

Requisitos Previos

Para comenzar, asegúrate de:
  • Tener acceso como administrador o desarrollador en el panel de administración de IUNI.
  • Generar las credenciales en la sección de desarrollo de IUNI.
  • Cumplir con los siguientes requisitos:
  • Te recomendamos realizar todas las pruebas en nuestro entorno sandbox para garantizar la estabilidad de tu integración. Esto es posible con las llaves de integración generadas en modo pruebas.
  • Las API de IUNI utilizan autenticación mediante tokens para proteger el acceso a tus datos y recursos.
  • Todos los datos de solicitud y respuesta se intercambian en formato JSON.

Autenticación y Seguridad

Todas las peticiones a la API requieren autenticación mediante un Bearer Token. Este token se obtiene después de realizar la autenticación del usuario a través del endpoint de login, utilizando credenciales codificadas en formato Base64. El Bearer Token debe ser enviado en el encabezado de cada solicitud para asegurar el acceso autorizado a los recursos de la API. Este token debe ser incluido en todas las solicitudes posteriores en el encabezado Authorization de la siguiente manera:

Authorization: Bearer <token>

Estructura de las Solicitudes

  • POST para crear nuevos recursos (usuarios, cuentas, transacciones).
  • GET para obtener datos.
  • PUT o PATCHpara actualizar recursos existentes.
  • DELETE para eliminar recursos.

Manejo de Errores

La API implementa un manejo de errores adecuado, devolviendo códigos HTTP y una descripción del error en caso de fallos. Aquí algunos códigos comunes:
  • 200 OK Solicitud exitosa.
  • 201 Created Recurso creado exitosamente.
  • 400 Bad Request Solicitud malformada o con datos incorrectos.
  • 401 Unauthorized Faltan credenciales o el token ha expirado.
  • 403 Forbidden El usuario no tiene permisos suficientes.
  • 404 Not Found El recurso solicitado no existe.
  • 500 Internal Server Error Error en el servidor.