Varios de nuestros endpoints y de nuestros webhooks están versionados. Para utilizar versionamiento y no romper sus integraciones, utilizamos un versionamiento basado en fecha. Es decir, cada fecha de versión siempre retorna el mismo objeto, tanto en la API como en los webhooks.
La forma del versionamiento es que dependiendo de la fecha seteada como header o registrada en el webhook, elegiremos la versión correspondiente del objeto.
Ejemplos
- default: Version 1
- 2024-08-13: Version 2
- 2025-01-14: Version 3
Dependiendo de la fecha que enviemos recibiremos diferentes versiones:
- 2024-05-12: Version 1
- 2024-08-13: Version 2
- 2024-08-17: Version 2
- 2025-01-13: Version 2
- 2025-03-01: Version 3
Es decir, siempre enviamos la ultima versión anterior a la fecha enviada.
Versionamiento Endpoints
Si se quiere usar el versionamiento se debe enviar un Header llamado X-API-Version
con una fecha en formato AAAA-MM-DD
. Si no se envía el Header se usa la versión por default.
Versionamiento Webhooks
El versionamiento de webhooks funciona por defecto. Esto significa que cada vez que se inscribe un webhook, este se inscribe con el día de inscripción como la fecha y por ende envía la última versión de ese momento. Si luego se agregan nuevas versiones no cambiará el objeto que se esta enviando.