Ir al contenido

Cambios de la API

Aquí anotamos cada cambio de la API: endpoints, parámetros y campos nuevos, y las correcciones que cambian una respuesta. Si ya integraste Colonix, es lo que te conviene revisar de vez en cuando. Los cambios del catálogo (una colonia nueva, un nombre corregido) no van aquí: esos te los da /v1/changes.

  • Dentro de /v1, los cambios solo agregan: endpoints, parámetros opcionales, campos en las respuestas o valores nuevos en un campo que ya existe. Nada se quita ni cambia de significado.
  • Tu código debe ignorar los campos que no conozca y aceptar un valor nuevo sin fallar. Por ejemplo, si tu código decide con el outcome de la validación, dale un camino para un valor que no conoce (como pedir que alguien revise la dirección).
  • Con los parámetros es al revés: la API no ignora uno que no conoce, responde 400 con unknown-parameter. Manda un parámetro nuevo solo cuando aparezca en esta página y en la referencia.
  • Un cambio que pueda romper tu integración llega en una versión nueva (/v2). Cuando exista, /v1 seguirá funcionando al menos 30 días, y te avisaremos por correo y aquí (Términos, sección 29).
  • Las correcciones de errores pueden cambiar una respuesta que era incorrecta; también se anotan aquí.

. Primera versión pública de la API, con 17 endpoints:

En toda la API: llave en x-api-key, solo GET y HEAD, errores en application/problem+json (errores), paginación con cursor y revalidación con ETag (paginación y versión del dato). El contrato completo está en OpenAPI.