Versión 2 de la Web API

La versión 2 de la Web API de la versión 10 del ERP presenta algunos cambios significativos con respecto a la versión anterior:

• Las respuestas tienen ahora una estructura única para todos los métodos;
• Uso de 4 tipos de petición HTTP (GET, POST, PUT, DELETE);
• Bloqueo de peticiones en simultáneo para el mismo contexto de integración;
• Utilización de Swagger como herramienta para documentar e invocar peticiones.

Endpoints

Todos los endpoints de la versión 2 pasan a ser complementados ahora con v2 antes de la identificación del módulo.

Así, la estructura base de la URL de los endpoints pasa a ser:

http://localhost:2018/WebApi/v2/{modulo}/{entidade}/{servico}/

Retorno de las peticiones

En la versión 2, la respuesta a todas las peticiones tiene ahora la misma estructura:

{

  "Version": "string",   "StatusCode": 0,   "ErrorMessage": "string",   "Results": {} }

Esta estructura pretende eliminar la complejidad de los http clients que ahora tienen una única estructura de retorno de peticiones.

Detallando las propiedades del objeto de retorno:

• Versión: Muestra la versión de la Web API invocada;
• StatusCode: En esta propiedad, se enviará el HTTP Status Code de la respuesta;
• ErrorMessage: En caso de error, muestra el mensaje correspondiente;
• Resultados: Objeto con el contenido del retorno. Este objeto será siempre un diccionario, cuya clave será un string (que corresponde al nombre de la entidad de retorno) y un objeto de retorno.
  • Las entidades que en la API del ERP se pasan como ref, se devuelven ahora en este objeto;
  • En el caso de los métodos de actualización de entidad de negocio, la entidad actualizada se envía en este objeto, debidamente actualizada (con el número realmente guardado, por ejemplo).

HTTP Request de cada petición

En la versión 2, utilizamos 4 tipos de HTTP Request:

• GET: utilizado en los métodos que devuelven datos (genéricamente los métodos de Consulta);
• POST: utilizados en los métodos que crean/actualizan entidades de negocio;
• PUT: utilizado en los métodos que actualizan atributos de las entidades de negocio (ej.: ActualizaValorAtributo);
• DELETE: utilizado en los métodos que realizan operaciones de eliminación de entidades de negocio.

Bloqueo de peticiones simultáneas para el mismo contexto

Está disponible la configuración BloquearMúltiplesPeticionesPorContexto (verdadero por defecto) en el archivo web.config que permite bloquear peticiones realizadas simultáneamente al mismo motor del ERP.

Los motores del ERP se instancian en función del token solicitado, garantizando la correcta separación de recursos cuando se instrumenta adecuadamente con la session key.

Cuando la session key no se utiliza, puede haber errores, ya que hay recursos compartidos que ahora se utilizan simultáneamente. De este modo, esta configuración permite evitar esos errores.

Para más información, consulte la sección Arquitectura de la documentación de la Web API.

Documentación de la Web API con Swagger

La versión 2 también ofrece como mecanismo de documentación e invocación de la Web API la herramienta Swagger.

La dirección por defecto de Swagger será http://localhost:2018/WebApi/swagger/ui/index

Esta pasa a ser también la página de entrada de la Web API, accediendo a http://localhost:2018/WebApi.

Más información sobre el uso de Swagger en el artículo de apoyo.