V10 RecursosWeb API
RecursosWeb API
Web API
Años | Lista de Artículos

Características de la Web API

Última modificación el 12/07/2024

La Web API de la versión 10 del ERP tiene algunas características propias que debe conocer antes de empezar a utilizar y que se mostrarán a continuación.

Instalación

Antes de empezar, necesita tener instalado el módulo de la Web API y el servidor IIS configurado y en funcionamiento. La Web API se ejecuta siempre en un servidor local, es decir, en la infraestructura del cliente.

 width=

Otra particularidad de la Web API es que no tiene por qué estar instalada en la misma máquina del ERP Cegid. Puede instalar la Web API en un servidor dedicado, simplemente modificando la clave "ERPInstalationPath" en el Web.Config.

End points de la Web API 

La Web API ofrece los endpoints de servicio en un formato de rutas específico. Todas las rutas están construidas a semejanza de la API, para facilitar la comprensión de los distintos recursos.

URL:

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

La ruta siempre tiene la misma estructura con los siguientes elementos variables:

  • Módulo: identifica el módulo al que pertenece el recurso de la petición.
  • Entidad: identifica la entidad a la que se quiere acceder.
  • Servicio: identifica la operación a realizar.

Ejemplo:

http://localhost:2018/WebApi/Base/Clientes/Actualiza

En el administrador del ERP, es posible controlar el acceso a los servicios de la Web API, teniendo en cuenta la configuración del perfil asignado al usuario.

Autenticación

La Web API requiere la autenticación de todas las peticiones realizadas. El método de autenticación utilizado es el estándar OAuth 2.0.

En la práctica, las peticiones a la Web API deben ir precedidas de una llamada a un endpoint, que realizará la autenticación del usuario y de la aplicación. Este endpoint es el siguiente:

http://localhost:2018/WebApi/token

Los parámetros son los siguientes:

  • username: nombre del usuario del ERP utilizado.
  • password: contraseña del usuario del ERP.
  • company: código de la empresa.
  • instance: instancia del ERP, normalmente "Default”.
  • línea: uno de los siguientes valores "evolution", "executive" o "professional"
  • grant_type: tipo de autenticación utilizado por el framework OAuth 2. En este caso será siempre "password";
  • clave de sesión: representa una clave única que proporcionará un contexto de integración independiente y aislado de las demás peticiones.

La respuesta a esta petición proporcionará el enlace de redirección al endpoint con los datos de autenticación:

  • access_token: el token de autenticación con su respectivo tiempo de vida.
  • token_type: Bearer.
  • expires_in: 1199.

Estos datos deben utilizarse en posteriores peticiones a la Web API, añadiendo los siguientes headers:

  • Authorization: Bearer {acess_token}.
  • Accept: application/json.

El tiempo establecido para que caduque el token (expired_in) puede cambiarse en el archivo Web.config, en la configuración TokenExpirationMinutes:

 width=

Renovación de token

Cuando el token caduca, se devuelve un error 401 – Unauthorized con el mensaje "Authorization has been denied for this request." En este escenario, debe realizarse la petición de un nuevo token, utilizando el mismo método que en la primera petición (/token).

Para garantizar que la renovación del token reutiliza el mismo contexto de integración, optimizando recursos y acelerando la respuesta, debe indicarse en el header de la solicitud el token anterior, que ya ha caducado (cabecera Authorisation).

Bookmark or share this article
Esta página foi útil?
Obrigado pelo seu voto.

login para deixar a sua opinião.

Obrigado pelo seu feedback. Iremos analisá-lo para continuarmos a melhorar!
Artículos Relacionados
Utiliza Postman para probar la Web API Formato de los pedidos Web API ERP10 ¿Cómo ejecutar listas en la WebAPI? Web API - Conceptos y arquitectura ¿Cómo extender la Web API?