Saltar al contenido

Versionado de API

El contrato público actual para integradores es OpenAPI v1, versionado en docs/api/openapi-v1.json en el repositorio y copiado al build estático de esta documentación. El fichero se genera y revisa separado de los endpoints internos o del portal.

  • Fija la versión de API/SDK usada por cada release de tu integración.
  • Usa modelos de respuesta explícitos y tolera campos adicionales solo si tu política de contrato lo permite.
  • Usa códigos de error de dominio estables en lugar de interpretar títulos.
  • Revisa scopes y metadatos de idempotencia cuando cambies operaciones.
  • No presupongas que un endpoint del portal es una operación pública soportada.