Control de versiones para métodos de la API
Las versiones con fecha se utilizan para cambios disruptivos y nuevas funciones seleccionadas.
Algunos métodos de la API individuales tienen una versión con fecha. Seleccione la versión que desee de la siguiente manera:
Para utilizar la versión con fecha, debe especificar la fecha en el parámetro de encabezado
api_versionen formato aaaa-mm-dd. Por ejemplo: 2023-11-29.Para utilizar un método de la API sin una versión con fecha, omita el parámetro de encabezado
api_version.
El control de versiones de un método de la API podría afectar a lo siguiente:
Solicitud o respuesta de REST
Webhooks
Comportamiento o lógica empresarial
Cambios no disruptivos
Los siguientes cambios generalmente se consideran no disruptivos y compatibles con versiones anteriores:
Nuevo método o punto de conexión.
Nuevo parámetro o campo opcional en el encabezado, el cuerpo de la solicitud, la respuesta o el webhook.
Nuevo valor en la lista de valores, rango más amplio para un parámetro numérico, mayor longitud para un parámetro de cadena.
Parámetro obligatorio cambiado a opcional.
Nuevo valor predeterminado para un parámetro.
Nuevo código y mensaje de error, o mensaje de error actualizado.
Nuevo webhook.
Cambios disruptivos
Los siguientes cambios generalmente se consideran disruptivos y podrían afectar negativamente al código de los clientes:
Punto de conexión eliminado.
Parámetro eliminado o nombre de parámetro cambiado en la solicitud de REST, la respuesta de REST o el webhook.
Nuevo parámetro obligatorio o parámetro opcional cambiado a obligatorio.
Valor eliminado de la lista de valores, rango más pequeño para un parámetro numérico, menor longitud para un parámetro de cadena.
Tipo de dato del parámetro cambiado.
Código de error cambiado.
Comportamiento sustancialmente diferente debido a un nuevo valor en una lista de valores u otra causa que afecte el uso o la funcionalidad de la API.