« Atrás

Novedades en la API REST de comerzzia para facilitar la comunicación

 

En Comerzzia estamos inmersos en un intenso proceso de expansión en diferentes mercados. Debido a esto, se hace necesario estandarizar algunos aspectos para permitir un fácil acceso a nuestras capacidades independientemente del pais o mercado en el que esté operando el partner y el retailer.

 

Anunciamos hoy una serie de cambios que introducimos en el API REST de comerzzia. Como ya conoces, la plataforma comerzzia dispone de una capa de servicios RESTfull para la integración entre los diferentes módulos que la componen, así como sistemas de terceros, externos a la misma.

 

comerzzia, dentro de su estrategia de internacionalización del producto e innovación tecnológica continua, incluirá en el próximo lanzamiento de la versión 5.0 una nueva versión 2.0 de su Catálogo de Servicios REST con un amplio conjunto de mejoras sobre el actual.


La expansión internacional de comerzzia es el principal motivo de peso que lleva a reestructurar la API para que tanto los mensajes como las respuestas sean legibles globalmente. Para ello, la nueva versión del catálogo REST estará completamente en inglés, tanto a nivel de definición como de documentación. Además, se aprovechará este salto evolutivo para incluir los siguientes avances:

  1. Incorporamos la autodocumentación de la API utilizando el estándar opensource OPENAPI (https://www.openapis.org/). Esta documentación estará ahora disponible mediante una URL pública, lo que permitirá consultarla online en su totalidad, facilitando el testeo de la misma y la visualización inmediata de los resultados.
  2. Generación automática de librerías de la capa cliente en todos los lenguajes de programación, proporcionando una rápida implementación del software en el lenguaje necesario.
  3. Separación de la capa de servicios REST de comerzzia del resto de módulos, lo que permite su despliegue en contenedores docker de forma autónoma e independiente.
  4. Reorganizamos el catálogo de servicios REST, clasificándolo en grupos que ahora están mas alineados con la estructura actual de módulos licenciados de la plataforma.
  5. Ampliamos el catálogo REST actual para incluir nuevos servicios.
  6. Preparamos el API para cualquier mercado, permitiendo ahora hacer peticiones enviando como parámetro opcional el idioma en el que se desea realizar la operación solicitada.
  7. Aumento de la seguridad mediante la utilización de tokens JWT para la autenticación de las llamadas.

Los beneficios principales que aportará esta nueva versión, serán:

  1. Solución basada en estándar de mercado.

  2. Catálogo adaptado a la internacionalización: Documentación y API en inglés.

  3. Catálogo público autodocumentado: Disponible para testing on-line.

  4. Agilidad en la implementación de capa de cliente, gracias a la generación automática de las librerías de cliente en cualquier lenguaje.

  5. Módulo de servicios centralizado, autónomo, que aporta facilidad en el despliegue y dimensionamiento basado contenedores Docker.

  6. Mayor seguridad basada en el protocolo JWT.

¿Qué ocurrirá con las versiones actuales de comerzzia?
Como ya se ha indicado, este nuevo módulo estará disponible a partir de la versión 5.0 de comerzzia. Para versiones anteriores del producto (3.0.x, 4.0.x y 4.6.x) se seguirán manteniendo los servicios REST asociados al catálogo actual. Éstos pasarán a estar obsoletos a partir de la versión 5.0.x, por lo que la adopción de esta nueva versión implicará adaptar las integraciones y desarrollos a medida existentes al nuevo catálogo.

 

¿Cómo procedo en caso de que mi cliente se actualice a la versión 5.0 de comerzzia? 
En caso de que sea necesario realizar una migración de un cliente con versión 4.6.x o inferior a una 5.0.x, como se ha comentado, será necesario adaptar los desarrollos a medida e integraciones sobre la versión del cliente. Para facilitar esta labor, comerzzia proporcionará una tabla de equivalencias entre el catálogo de servicios REST asociado a estas versiones y el nuevo catálogo de servicios REST, que servirá de guía para el desarrollador. Asímismo, este documento también incluirá la equivalencia entre los parámetros de llamada del catálogo actual, en español, con su equivalente en la nueva API, en inglés. 

 

Esperamos que todas estas mejoras y nuevas capacidades agilicen la puesta en marcha de vuestros proyectos basados en comerzzia.