Versionado
Cómo cambia la API y cómo se lo comunicamos.
La versión está en la ruta: /api/v1.
Dentro de v1 solo hacemos cambios que no afectan a una integración correcta:
- nuevos endpoints;
- nuevos campos opcionales en las solicitudes;
- nuevos campos en las respuestas;
- nuevos códigos de error y nuevos valores de
status.
Lea las respuestas con tolerancia: ignore los campos que no conozca.
Un cambio incompatible da lugar a una nueva versión (/api/v2), que se anuncia con antelación a los propietarios de cuentas de API.
La descripción de la API en formato legible por máquina está en /api/v1/openapi.json, para Postman o un generador de clientes.