Floid Developers Contáctanos

Guías

Respuestas y paginación

Todas las herramientas responden con la misma forma, sin importar el banco o la institución.

Forma de la respuesta

Éxito · HTTP 200

{
  "data": {
    "…": "…"
  },
  "meta": {
    "herramienta": "sii.f22.consultar",
    "caseid": "3f1c…"
  }
}

Error · HTTP 4xx / 5xx

{
  "error": {
    "codigo": "INVALID_CREDENTIALS",
    "tipo": "…",
    "mensaje": "…",
    "sugerencia": "…",
    "reintentable": false
  },
  "meta": {
    "herramienta": "sii.f22.consultar",
    "caseid": "3f1c…"
  }
}

Normalización

La capa corrige diferencias entre bancos para que tu código no tenga casos especiales:

DatoFloid entregaLa capa entrega
Montos (in, out, balance, total…)"15725662"15725662
Fechas"01/09/2021", "01-09-2021""2021-09-01"
Valores vacíos"None"null
Fechas de entradaDistinto formato por endpointSiempre YYYY-MM-DD

Paginación

Las herramientas paginables (por ejemplo banco_persona.movimientos.consultar) aceptan offset y limite. Si quedan elementos, la respuesta trae meta.pagina:

{
  "meta": {
    "herramienta": "banco_persona.movimientos.consultar",
    "caseid": "c-1",
    "pagina": {
      "total": 340,
      "offset": 0,
      "limit": 50,
      "has_more": true,
      "caseid": "c-1"
    }
  }
}

Para pedir la siguiente página, repite la llamada con el caseid de meta.pagina y offset más limite. Floid sirve esas páginas desde su caché, sin volver a entrar al banco. Cada página trae un meta.caseid nuevo, pero meta.pagina.caseid sigue siendo el original: usa siempre ese.

{
  "herramienta": "banco_persona.movimientos.consultar",
  "parametros": {
    "banco": "bci",
    "credencial_token": "<credencial_token>",
    "cuenta": "12345678",
    "caseid": "c-1",
    "offset": 50,
    "limite": 50
  }
}
Página por defecto en REST100 elementos (la de Floid)
Página por defecto en MCP50 elementos, para no llenar el contexto del agente