Best integration practices

We compiled a set of best practices that must be observed when using the Web API to ensure a positive customer and user experience. These best practices cover several aspects of the development of integrated applications.

Data security and privacy

The security and privacy of the data used in the Web API is a very important aspect that requires full attention during development.

Firstly, it is very important to ensure the security of all the data used by the integrated application to access the API (such as the ClientId). Responsibility for the privacy of this information lies with the developer, who must be aware that these details will be used to identify your application in our systems. PRIMAVERA reserves the right to deny access to applications making some type of improper use of the API.

The users' data, such as the username, password and email address, are the property of the corresponding users and their security and privacy must be protected in all circumstances.

Finally, the customers' data  and company must also be protected and managed with all due care. We recommend not storing this type of information, extracted through the Web API, in the integrated application.

Hosting of integrated solutions

PRIMAVERA does not currently offer the ability to host integrated solutions, although it may become possible in the future. Therefore, the developer is responsible for hosting the application.

From the perspective of the end customer it is important for the solution (Jasmin/ROSE + integrated application) to works well, with guaranteed performance and availability.

The PRIMAVERA team is always happy to give development teams advice regarding these practices.

Load from Web API requests

It is important for the application to make use of the Web API responsibly as it affects the subscription of the actual customer used in the requests.

The Web API includes throttling mechanisms to ensure system protection in terms of denial of service and overload. Under these conditions, the Web API will return errors in response to requests.

Regardless of these mechanisms, the application needs to make an efficient use of the API:

• Only make those requests which are strictly necessary to ensure the functionality of the application.
• Pooling requests, for example, to detect new records created by the customer, should be avoided.
• Consecutive requests with abnormal quantities should be avoided.

Database templates