Saltar al contenido principal

Introducción

Cada endpoint está documentado con sus parámetros, los esquemas de request y response, los códigos de error y ejemplos ejecutables desde el navegador ("Try it"). La referencia se agrupa por dominio:

Especificación OpenAPI

El contrato completo se publica como un único archivo OpenAPI 3.1:

⬇ Descargar openapi.yaml

URL canónica: https://api-docs.max.capital/openapi/openapi.yaml

Es la misma fuente con la que se construye esta referencia, así que no hay diferencias entre lo que leés acá y lo que consume tu código. Te sirve para:

  • generar un cliente en tu lenguaje (openapi-generator, oapi-codegen, NSwag, etc.);
  • importar la API en Postman, Insomnia o Bruno y armar tu colección;
  • validar payloads contra los esquemas en tus tests.

El campo servers del archivo declara la Base URL de desarrollo: es el ambiente contra el que ejecuta el "Try it". Las Base URLs de cada ambiente están en Convenciones.

Antes de empezar

  • Las credenciales son propias de cada ambiente. ¿Necesitás las de desarrollo? Escribinos.
  • El Inicio Rápido te lleva del cero a tu primera llamada.
  • Las reglas que valen para todos los endpoints — versionado, formato de fechas, estructura de errores y límites de uso — están en Convenciones.