Web API - Concepts and Architecture

One of the most important features of version 10 of the PRIMAVERA ERP is that it now provides valuable help for organizations to overcome their boundaries. Right from the start, although it does not require a continuous connection, having an Internet connection is no longer optional, which creates many opportunities. Technologically, the new Web API is now the bridge between the application and the world.

This is a Web API REST that fully covers the entire range of features of the ERP. This layer implements security mechanisms, cache and a set of services that enable a connection to the ERP with the best performance and all the security.

The attributes of this technology make the Web API a fundamental part for integrating with several different systems, which means that it is now perfectly possible to integrate with any operating system or device with Internet access.

Integrating with online tools and services is also done using a fluid and completely secure method, whether the goal is to integrate with e-commerce portals, manufacturing equipment, climate sensors, automobiles, home appliances, wearables, or any other Internet-enabled software system or device.

This is undoubtedly a technology that allows us to focus development on the most diverse current trends, such as Logistics and Industry 4.0, Mobile-solutions, IoT, Analytics, Augmented Reality, etc.

Architecture

The WebAPI includes an integration layer that is responsible for the connection with the ERP. This component receives authentication requests and stores them in a cache, according to the API-generated token.The WebAPI is a layer that invokes the product API, so this layer does not add more business rules than the current one.

The WebAPI benefits from a cache system and reuses the same API instance per user (access TOKEN). This mechanism has its advantages, such as performance improvements, but requires the creation of multiple users, when creating several requests simultaneously and not sequentially. In our multithread environments, the app reuses the same connection to the database, which can cause duplicate log errors.

Connection with the ERP

The WebAPI requires information about the ERP's installation path, which may be different from that suggested during installation (Program Files (x86)PRIMAVERASG100AplWebApi) and specified in the ERPInstalationPath setting of the Web.Config file.

The service layer is regenerated for each build according to the public interface provided by the ERP API.

Logging

The WebAPI can keep a log of requests, with information on the location and method used, which can also be configured in the Web.Config file.

The nlog element allows you to configure this log. Please find below an example of this configuration is performed:

Internet Information Services (IIS)

The installation process detects the existence of IIS on the machine. After installation, you need to ensure that the following settings are configured:

The Web API of version 10 of the PRIMAVERA ERP is one of the main technological concepts of this version.

Modules made available by the WebAPI

• Sales
• Purchases
• Inventory
• Accounting
• Human Resources
• Cash Management
• Contacts and Opportunities
• Internal
• Payables and Receivables
• Projects