Versionado

Qué versión de la API y del formato de factura están vigentes, y qué cambios pueden llegar sin que cambie la ruta.

Versión vigente

• API: /api/v1.1. La versión va en la ruta y es la única versión pública.
• Formato de factura: json_1_1. Es el único valor de schema_version que se acepta; cualquier otro se rechaza con unsupported_schema_version.

Compatibilidad

Dentro de /api/v1.1 pueden llegar cambios que no rompen una integración bien hecha:

• operaciones nuevas;
• campos nuevos en las respuestas;
• parámetros opcionales nuevos;
• códigos de error nuevos.

Un cambio incompatible, como quitar o renombrar un campo, cambiar su tipo o volver obligatorio uno opcional, no se publica sobre /api/v1.1: iría en una ruta nueva, por ejemplo /api/v2.

Cómo preparar tu integración

• Ignora los campos que no conozcas en las respuestas.
• Decide con code, no con message: los textos pueden cambiar.
• Si recibes un code que no conoces, trátalo según su código HTTP.
• En las peticiones, envía solo los campos documentados: algunas operaciones rechazan los que no conocen.

:::info Roadmap Las notas de versión (changelog) y la página de estado del servicio todavía no están publicadas. :::

Ver también

• Referencia de la API
• Formato canónico
• Errores