Saltar al contenido principal

Ejemplo de uso utilizando Postman

En este ejemplo se muestra como utilizar el servicio de OpenFinance en la herramienta Postman.

Requisitos​

  • Conocimientos básicos de API REST
  • Conocimientos básicos de Postman
  • Contar con una API KEY

1.- Descarga la colección de Postman​

Descarga la colección de Postman desde el siguiente enlace: OpenFinance Postman Collection

2.- Importa la colección de Postman​

Haz click en el botón de importar y selecciona la colección descargada.

Postman Import

Obtendrás una colección con los siguientes endpoints:

Postman Collection

3.- Configura las variables de ambiente​

Haz click en la opción Environments y crea un nuevo ambiente.

Postman Environments

3.1.- Configura las variables​

  • URL: URL del servicio
  • API_KEY: API KEY del servicio

Postman Variables

4.- Utilizando el servicio​

Aquí se describe las respuestas de los endpoints mas importantes.

Para mas información visita la documentación de la API

4.1.- Obtener el token de acceso​

Utilizaremos el endpoint Get token /login para obtener el token de acceso.

Response:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkIjoiYXV0aCIsInJlc3RyaWN0ZWQiOmZhbHNlLCJpYXQ"
}

4.2.- Crea una tarea de extracción​

Utilizaremos el endpoint Create task /tasks para crear una tarea de extracción.

{
    "taskId": "df50e9e2eadc"
}

4.3.- Obtener el estado de la tarea​

Utilizaremos el endpoint Get task status /tasks/{taskId} para obtener el estado de la tarea.

{
    "taskStatusCode": 200,
    "taskStatus": "success",
    "results": {
        "username": "12.312.312-3",
        "entityId": "banco-niubank",
        "data": [
            ...
        ]
    }
}