Saltar a contenido

Formance API reference introduction

Summary

Introducción a la API reference de Formance. Explica que la API cubre endpoints, request/response y ejemplos. Describe dos modos de uso del playground: proxy local con fctl o llamadas directas autenticadas contra Formance Cloud.

Key Points

  • La API puede usarse mediante fctl stack proxy para desarrollo.
  • Las llamadas directas a Cloud requieren URL con organization, stack y environment.
  • La autenticación usa bearer token, con OAuth 2.0 client credentials o personal tokens.
  • La documentación interactiva puede probar endpoints desde el navegador.

Evidence

  • API URL pattern: https://{organization}-{stack}.{environment}.formance.cloud/api/{service}/{endpoint}.
  • Direct API Authentication requiere valid bearer token.
  • fctl proxy evita gestionar bearer token durante pruebas locales.

Open Questions

  • Confirmar hosting: Formance Cloud, self-hosted Community o Enterprise.
  • Definir gestión de secretos, OAuth clients y segregación de stacks para sandbox/prod.
  • Raw local: raw/formance/formance-api-reference-introduction.md
  • Source URL: https://docs.formance.com/api-reference/introduction