¿Un producto de APIs puede tener más de una versión? arrow2-down

Es posible que una nueva versión de una API o un producto de APIs conviva con la versión obsoleta. Máximo conviven 2 versiones a la vez (la que se va a jubilar/retirar y la superior que evolucionó).

 

También te puede interesar ¿Cuánto tiempo se mantiene una versión que va a ser jubilada?

¿Qué significa el número que aparece en el nombre de las APIs? arrow2-down

Los números que acompañan los nombre de las APIs y los productos de APIs, son su versión. Por ejemplo, Bancolombia Button 2.0.4; el número siempre es visible, dado que todos están versionados. 

 

Es importante tener en cuenta que, al momento de consumir una API o un producto de APIs, se tenga presente su versión, porque un cambio de versión puede significar un ajuste para su consumo.

¿Qué pasa si sale una nueva versión de una API? arrow2-down

Cuando la versión de una API o un producto de APIs evoluciona debes actualizar tus aplicativos con la versión más reciente de la API, ya que la versión que consumes se jubila/retira.

 

Ante estos cambios te estaremos notificando de la salida de la versión, sus características y/o cambios, así como la fecha tentativa en la que se dará de baja la versión que estas consumiendo. Te puede interesar leer ¿Cuánto tiempo se mantiene una versión que va a ser jubilada?

 

Recuerda que si las APIs que consumes ya se jubilaron, tu aplicación o solución digital queda sin productos de APIs suscritos.

Si necesitas más información, te invitamos a ver el reglamento de APIs.

¿Cuál es la estructura del versionamiento de las APIs y qué significa? arrow2-down

El número de versión tiene una estructura: X.Y.Z, estos números son enteros no negativos. 

 

Cada número clasifica su impacto: 

  •  X es la versión Mayor, con ella se introducen modificaciones importantes en la funcionalidad (Interna o Externa) de la API o del producto de APIs, que rompen la compatibilidad de las dependencias. 
  • Y la versión Menor, estas modificaciones no rompen la compatibilidad de las dependencias y adicionan funcionalidades a las APIs.  
  • Z la versión Parche significan correcciones puntuales en la API o producto de APIs, corresponde a un cambio interno. 
¿Cuánto tiempo se mantiene una versión que va a ser jubilada? arrow2-down

El tiempo en el que se deja disponible una versión que se va a jubilar/retirar varía y se comunica a través de los medios establecidos por Bancolombia, este es máximo de un (1) año. 

 

Si estás consumiendo una versión anterior realiza los ajustes a las implementaciones respectivas, después de ese periodo, la API o producto de APIs quedará sin funcionalidad.

 

Te puede interesar ¿Qué pasa si sale una nueva versión de unas APIs?