How to encrypt an API request and response?

Athento allows working with encrypted API services.

In order to maintain an encrypted API flow,  it is necessary to send in the requests, the HEADER X-Athento-Encrypted with the value "true".

If the request that Athento receives has this header configured, it will assume that the content of the request is encrypted and, therefore, it will also encrypt the response with the corresponding key.

The following screenshot is an example of a request with the X-Athento-Encrypted header.

To make the encrypted call it is necessary to make the request with the Content-Type of the unencrypted payload so that Athento can perform the security layer checks. Below is an example of an encrypted request with the REST Postman client for the creation of a document in Athento whose raw mode payload is an encrypted JSON.

Below is an example of an encrypted request with the REST Postman client for the creation of a document in Athento whose raw mode payload is an encrypted JSON.

IMPORTANT
The use of encrypted services requires some configurations at the installation level
by our support team.