Campos requeridos para iniciar sesión

Endpoint: GET /provider/{code}/

Al iniciar la operativa con nuestra API Bancaria, lo primero que debes hacer es iniciar sesión al banco deseado con las credenciales del usuario final.

Cada banco puede variar sus parámetros de inicio de sesión, por lo que mediante esta consulta podrás obtener todos los campos requeridos para iniciar sesión correctamente en un banco en particular.

Parámetros requeridos

  • No hay parámetros específicos para realizar esta consulta.

📘

¡Recuerda tu API KEY!

Recuerda que todas las requests deben incluir el API key, ya sea usando el header X-API-Key o el parámetro api_key en la url.

Respuesta:

STATUS

DESCRIPCIÓN

provider.auth_fields

Lista de campos para la autenticación en el proveedor.

Campos:

  • interactive, indica si el campo se debe enviar de manera interactiva o no*
  • name, indica el nombre del campo que debemos completar.
  • type, indica el tipo de campo. El mismo puede ser un string o choice.
  • optional, indica si el campo es opcional o no.
  • label_en, descripción del campo en inglés
  • label_es, descripción del campo en español

provider.country

País del proveedor.

provider.name

Nombre del proveedor.

account_type

Lista de campos que indica el tipo de cuenta con que opera el proveedor.

Campos:
-name, indica el nombre del tipo de cuenta (Personal - pers, Corporativa - corp, Pymes - smes)

  • label_en, descripción del campo en inglés
  • label_es, descripción del campo en español

logo

URL del logo del proveedor

status

Estado del proveedor.

*) ¿Que quiere decir que un campo se envie de manera interactiva?

Los campos interactivos se envian como resultado de una respuesta de tipo interacción requerida, es decir que la misma API nos indicará con el status interaction_required cuando enviar dicho parámetro.

Ejemplos

Solicitar campos requeridos para iniciar sesión a los bancos

GET /provider/test/ HTTP/1.1
Host: banking.sandbox.prometeoapi.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>
curl -X GET "https://banking.sandbox.prometeoapi.com/provider/test/"  -H "X-API-Key: <API KEY>"
import requests

requests.get('https://banking.sandbox.prometeoapi.com/provider/test/', headers={
    'X-API-Key': '<API KEY>'
})
var request = require('request');

request.get({
  "url": "https://banking.sandbox.prometeoapi.com/provider/test/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  }
});

Respuesta exitosa

{
    "status": "success",
    "provider": {
        "name": "test",
        "country": "UY",
        "auth_fields": [
            {
                "name": "username",
                "type": "text",
                "interactive": false,
                "optional": false,
                "label_es": "Usuario",
                "label_en": "Username"
            },
            {
                "name": "password",
                "type": "password",
                "interactive": false,
                "optional": false,
                "label_es": "Contraseña",
                "label_en": "Password"
            }
        ],
        "account_type": [
            {
                "name": "pers",
                "label_es": "Cuenta Personal",
                "label_en": "Personal Account"
            },
            {
                "name": "corp",
                "label_es": "Cuenta Corporativa",
                "label_en": "Corporate Account"
            }
        ],
        "logo": "https://providers.prometeoapi.com/logos/test.png"
    }
}

Respuesta errónea

{
  "status": "provider_doesnt_exist"
}

Did this page help you?