Introducción a la referencia de API
¿Qué es la API de Datos Abiertos?
La API de Datos Abiertos de Khipu permite acceder a nuestros servicios de forma programática, exponiendo los datos en un formato bien definido y consistente. Puedes consumir esta API para desarrollar integraciones con múltiples fuentes de datos utilizando el patrón REST, esperando URLs orientadas a recursos y respuestas codificadas en JSON, con códigos de respuesta HTTP estándar y métodos de autenticación.
Puede utilizar una clave API individual para acceder a los recursos de forma segura. Ambos métodos se explican en la sección Autenticación.
Todas nuestras API se construyen utilizando la especificación OpenAPI para las definiciones de servicio, de modo que la interacción con los métodos es uniforme y las interfaces se conocen de antemano.
Casos de uso
Las APIs de Khipu proporcionan un conjunto de servicios que permiten a los desarrolladores construir soluciones innovadoras utilizando datos en tiempo real, integrando información de diversas fuentes utilizando un estándar sencillo. Con estas herramientas se pueden crear productos de gran valor, como por ejemplo
Acceder a datos financieros en tiempo real
Puede tener una visión inmediata de sus finanzas accediendo a sus transacciones diarias actualizadas de todas sus cuentas bancarias y crear después un cuadro de mando que muestre la evolución de sus ingresos y gastos.
Enriquecer los datos existentes
Puede enriquecer los datos procedentes de otro sistema con el detalle preciso de la transacción subyacente y tener siempre una imagen correcta de sus movimientos (como las ventas, por ejemplo).
Descubra la información de sus finanzas
Al poder acceder a los estados financieros históricos, podrá tener una visión más profunda de todos sus movimientos, identificando fuentes de ingresos, gastos y creando sus propias soluciones analíticas.
Automatizar flujos de trabajo
Puede programar su programa para obtener datos periódicamente y construir una línea de tiempo con todos los puntos de datos necesarios.
Cómo está organizado este sitio
Este portal de documentación está dirigido a desarrolladores que deseen familiarizarse con nuestra API REST realizando solicitudes específicas mediante llamadas Postman o nuestra funcionalidad "Pruébalo", pero también es útil para ayudarle a mejorar soluciones existentes, proporcionando fragmentos de código en un conjunto de lenguajes de programación populares que sirven como punto de partida.
A la izquierda, tienes una barra lateral con todas las opciones relevantes para navegar por este sitio, como nuestra Guía de inicio rápido o el proceso de Autenticación, y acceso directo a la referencia OpenAPI. Estas definiciones están agrupadas por regiones geográficas y según la lógica de negocio implicada, como la Banca.
El panel central es el contenedor principal de la sección del sitio que está visitando, y en el caso de las definiciones OpenAPI tendrá una consola con el panel "Pruébelo" y las muestras de solicitud y respuesta. Ver imagen inferior.
Por último, en la barra de navegación superior hay un cuadro de búsqueda que le permite encontrar rápidamente un método específico o cualquier sección del sitio.