Versiones y compatibilidad

La API lleva su versión en la ruta, /v1, y una fecha: la del documento OpenAPI (info.version), el día de su último cambio. Cada cambio tiene su entrada en Novedades.

Los cambios compatibles

Llegan a /v1 cuando están listos, con su entrada el mismo día:

• un nuevo endpoint, un nuevo campo en una respuesta, un nuevo parámetro o campo opcional en una petición;
• un nuevo valor de una cadena que la referencia describe como abierta (como payment.method) y un nuevo code de error;
• un nuevo permiso (scope) y un nuevo idioma.

Para que ninguno rompa tu integración: ignora los campos que no conoces, trata un valor desconocido de una cadena abierta como un caso genérico y prevé una rama para los code de error que no gestionas uno por uno.

Las páginas de Vimine (el inicio de sesión, el formulario de adhesión, la agenda) pueden cambiar de aspecto en cualquier momento; sus direcciones y los parámetros que aceptan siguen las mismas reglas que la API.

Los cambios que requieren una acción

Un campo eliminado o renombrado, un parámetro que pasa a ser obligatorio, una respuesta que cambia de significado: un cambio así se anuncia al menos 30 días antes de llegar, con una entrada Acción necesaria que dice qué cambiar y antes de cuándo, y con un correo a las cuentas de desarrollador y a quien dirige una asociación con una app activa. Cuando llega, una segunda entrada lo dice.

Durante la beta, un cambio así llega a /v1. Después de la beta llegará en una nueva versión, /v2, junto a /v1 durante al menos seis meses.

El SDK y el plugin de WordPress

• @vimine/sdk: mientras la versión sea 0.x, un parche (0.3.6) nunca te pide cambiar tu código; una versión menor (0.4.0) puede hacerlo, y su entrada dice qué. Las entradas están también en el paquete, en CHANGELOG.md.
• El plugin de WordPress se actualiza desde WordPress.org, donde su ficha recoge las mismas entradas.

Seguir las novedades

• La página Novedades y su feed Atom, en cada idioma del portal: /es/news.xml en español, /news.xml en italiano, y así sucesivamente.
• En la consola de Vimine, Desarrolladores muestra las últimas entradas.
• Las entradas Acción necesaria llegan también por correo.