Guías de integración › Guía de referencia de la API de BFC › Construcción de URL › Control de versiones y agrupación de API

Control de versiones y agrupación de API

Las API de BFC se agrupan mediante el prefijo de aplicación 'BFC' en la URL. El prefijo de aplicación irá directamente detrás del host en la URL.

Todas las API son compatibles con el control de versiones. Los números de versión de API son relativos a la API misma, no a BFC. De esta forma, no es necesario cambiar la versión de la API cuando cambie la versión de BFC. Una versión de API tiene dos partes, un número principal y uno secundario. Pueden coexistir varias versiones de las API al mismo tiempo. En el futuro, se establecerán procedimientos para interrumpir el soporte para una versión, pero la compatibilidad con versiones anteriores nunca se romperá en una versión donde cambia solamente el número de API. Los registros de carga útil pueden cambiar entre versiones. La URL que se utiliza para identificar versiones de la API también identificará la versión de registro. El registro mismo no contendrá ningún número de versión. Sin embargo, algunas API pueden incluir la versión en el nombre del registro.

La disponibilidad inicial de las API de BFC se incluirá en la versión de 3.5.0 de BFC. La versión inicial de la API será 1.0. Un cliente solicita una versión de API estableciendo una sesión con un URI de inicio de sesión de versión explícito. Todas las versiones de BFC serán compatibles con un URI de inicio de sesión de versión explícito para cada versión de API compatible. Los URI distintos de los de inicio de sesión no contendrán números de versión explícitos.

URL de ejemplo para la versión inicial:

https://<bfchost>:8443/BFC/1.0/login
https://<bfchost>:8443/BFC/...

Si, hipotéticamente, una versión futura de BFC incluyera un cambio en las API del grid y deseara continuar con el soporte para la API 1.0, las siguientes URL se podrían usar en la nueva versión:

https://<bfchost>:8443/BFC/1.0/login
https://<bfchost>:8443/BFC/1.1/login
https://<bfchost>:8443/BFC/grids/...

Observe que la versión 1.1 podría contener también API nuevas que no existían en 1.0, en cuyo caso se podrían introducir URL nuevas:

https://<bfchost>:8443/BFC/servers/...

Un cliente conectado al URI 1.0 no tendría acceso al URI de los nuevos servidores: los intentos de acceso devolverían error HTTP 404.