Guía de Inicio Rápido

Tu primera llamada a la API en pocos pasos.

Guía de Inicio Rápido

Esta guía te lleva desde cero hasta tu primera consulta exitosa. Usaremos los servicios Optimus como ejemplo, porque la mayoría de las integraciones parten ahí.

Paso 1 — Reúne tus credenciales

De MBI recibirás:

  • IdEmpresa — identificador numérico de tu empresa.
  • Usuario y clave — el IdCodigo y Password con que obtendrás el token de sesión.

Para los servicios FX Spot, además, un x-api-key y un x-api-secret.

Paso 2 — Obtén un token de sesión

Antes de consultar cualquier servicio Optimus, solicita un token con Session/obtenerToken. El token que devuelve es lo que usarás en la cabecera X-SESSION-TOKEN del resto de las llamadas.

curl -X POST "/Session/obtenerToken" \
  -H "Content-Type: application/json" \
  -d '{
    "IdEmpresa": 1,
    "IdCodigo": "TU_USUARIO",
    "Password": "TU_CLAVE"
  }'

Respuesta:

{
  "ContadorErrores": 0,
  "Mensajes": [],
  "Token": "eyJhbGciOi..."
}

Paso 3 — Haz tu primera consulta

Con el token en la cabecera, ya puedes consultar. Este ejemplo pide los saldos de un cliente por su documento de identidad.

curl -X POST "/CuentaInversion/consultarSaldos" \
  -H "Content-Type: application/json" \
  -H "X-SESSION-TOKEN: eyJhbGciOi..." \
  -d '{
    "IdEmpresa": 1,
    "IdUsuario": "TU_USUARIO",
    "ClaveUsuario": "TU_CLAVE",
    "CuentaInversion": [
      {
        "IdInterno": 0,
        "Filtro": "DocumentoIdentidad",
        "Valor": "12721971-0"
      }
    ]
  }'

Paso 4 — Interpreta la respuesta

Todas las respuestas Optimus incluyen ContadorErrores y un arreglo Mensajes. Si ContadorErrores es 0, la operación fue exitosa; los datos vienen en el arreglo correspondiente al servicio. Si es mayor a 0, revisa Mensajes para el detalle del problema.

Patrón de filtros

Muchos servicios de consulta Optimus usan el mismo patrón: un arreglo de objetos con IdInterno (correlativo del grupo de filtros), Filtro (el nombre del campo a filtrar) y Valor. Puedes combinar varios filtros separando nombres y valores con ; en el mismo orden. Los filtros disponibles para cada servicio están listados en su referencia.

Siguiente paso

Revisa Autenticación y Ambientes para entender la diferencia entre sandbox y producción, y el detalle de las cabeceras de cada familia de servicios.


Did this page help you?