Altamira HRM offers its customers a complete API (Application Programming Interface) with which it is possible to read and write data contained in the platform. Unlike other APIs established by vendors that cannot be modified, Altamira HRM's API is dynamic and it is built by the customer according to their own specific needs.

This is made possible by Altamira's dynamic engine for setup managing. In Altamira the data are displayed and updated using views and in this the API behaves like any other feature on the platform. Therefore, in order to read or write data using the API you must first create a new view (or select an existing one) that contains the fields you wish to manage.

In order to access APIs, your organization must be enabled for their use. In addition, in order to provide access you will need to create one or more tokens.

Altamira APIs have two implementations:

• a fully self-documented SOAP implementation, with dynamic generation of the WSDL
• a REST implementation with dynamic  generation of the OpenApi document. For the latter, a Swagger interface is also available (you must be logged in to the platform).

The REST interface has two versions: v1 and v2. Altamira will continue to release new features in v2 while v1 is kept only for backward compatibility with legacy applications and will not be developed further.

The articles in this section are divided into two parts. In the first you will find the description for the v2 version of the REST and in the second one for the v1 version and for the SOAP.