OpenAPI y Postman

Publicamos la especificación completa de la API en formato OpenAPI 3.1. Sirve para:

• Generar SDKs en cualquier lenguaje (TypeScript, Python, Go, etc.).
• Importar la API en Postman, Insomnia, Bruno o cualquier cliente HTTP.
• Validar tus requests contra el contrato antes de enviarlas.

Descargar la especificación

Descargar openapi.yaml

URL estable:

https://developers.fi-nova.com/openapi.yaml

El archivo se versiona junto con la API. Cuando lancemos v2, conservaremos v1 en una ruta separada.

Importar en Postman

1. Abre Postman → File → Import.
2. Pega la URL: https://developers.fi-nova.com/openapi.yaml.
3. Postman creará una colección Finova for Developers API con los cuatro recursos y todos los endpoints listos para usar.
4. En la pestaña Variables de la colección, define baseUrl (ya viene con el servidor de producción) y agrega tu API key en Authorization → Bearer Token.

Si tu organización usa Postman Cloud, puedes "fork-ear" la colección a tu workspace y compartirla con tu equipo. Cada request hereda el header Authorization definido a nivel de colección.

Importar en Insomnia

1. Create → Import From → URL.
2. Pega https://developers.fi-nova.com/openapi.yaml.
3. Insomnia detectará los servers y los expondrá como Environments.

Importar en Bruno

bruno open --import https://developers.fi-nova.com/openapi.yaml

Generar un SDK con openapi-generator

npx @openapitools/openapi-generator-cli generate \
  -i https://developers.fi-nova.com/openapi.yaml \
  -g typescript-fetch \
  -o ./finova-sdk

Reemplaza typescript-fetch por el generador que necesites (python, go, ruby, php, etc.). La lista completa está en la documentación de openapi-generator.

Diferencias con la documentación

La especificación OpenAPI es la fuente de verdad del contrato (tipos, errores, scopes requeridos). Las páginas de Referencia explican casos de uso y ejemplos en código; la spec es el contrato exacto. Si encuentras una discrepancia, el OpenAPI manda — repórtanos el desfase para corregir la documentación.