Ir al contenido

Compatibilidad y versionado

Cada evento incluye api_version con el valor "v1". Prepare su integración para ignorar los campos que no reconozca: así seguirá funcionando si los eventos incorporan campos nuevos.

Cada evento incluye el campo api_version en su estructura común.

ValorEstado
v1Versión vigente.
RecomendaciónMotivo
Lea solo los campos que necesita y no falle ante campos desconocidos.Pueden aparecer campos nuevos.
No valide el cuerpo con un esquema que rechace propiedades adicionales.Un esquema estricto fallaría cuando se agregue un campo.
No dependa del orden de las propiedades del JSON.El orden de las propiedades de un objeto JSON no es significativo.
Verifique api_version y registre los valores que no reconozca.Detecta a tiempo una versión nueva.

Revise las buenas prácticas.