General usage
Integrations to the service can be implemented through the Nepton Application Program Interface (API). Usage of the API requires special API key, available from Nepton.
The requesting system can make service requests to Nepton API at any point. This enables real-time integrations and allows usage of immediate return codes and messages.
There are two parts of the API. First part is used for HR information. Second part is used for event activities, absences and project records. Both parts are documented in the following chapters.
API request types defined in this document are supported and can be used.
API allows viewing and management of various data records. Supported information content includes:
- Personnel information
- Work relationship information
- Events
- Projects
Best practices for API usage
Each API call is authenticated. Authentication is done with one of the persons credentials, which is set up. For good data security it is recommended to only grant the needed roles for the person used for API authentication. For example if the API implementation does not utilize HR data, then smallest role for accessing the HR data should be granted.
It is also recommended that each API implementation will use a dedicated person. To ensure good data security credentials should never be shared between API implementations. By creating unique persons it also allows the logs to indicate which person and which API implementation was used for API calls.