When there is a need to transfer data between Nepton and another service, the Nepton Application Program Interface (API) is an excellent alternative to an SFTP integration. Integrations can, in other words, be implemented by using Nepton API.
The requesting system can make service requests to Nepton API at any point. The requesting system is defined by the customer. A third party can also be involved in implementing the requesting system. API requests can be created in different applications or, for example, onto a server where they are run by scripts as needed. The implementation of the API usage is up to the customer to decide. This article and other API related articles help the customer or a third party to set up the API interface.
Nepton API is utilized, for example, when importing projects and events to Nepton and in these imports the additions and changes relayed from the customer's system are immediately updated into Nepton.
Nepton has two API endpoints to which requests can be sent. The other one is HR API including
- Personnel information
and the Worktime API including
- Worktime events
- Projects, cost centers, work orders which are treated like Projects in Nepton.
Deployment of Nepton API
1. The Worktime API (worktime events, absences and projects) needs to use CustomerId in the request, which can be obtained from a Nepton contact or customer service. The authentication for worktime API is described here.
2. The HR API usage requires a DeploymentId and a Webservicepassword, which can be obtained from a Nepton contact or customer service. HR API is described here.
3. The API requests are authenticated. Authentication requires user login information and changes made via the API are seen as this user's actions. For this purpose and to ensure information security, for each API implementation a user account needs to be created. This account is seen the log when, for example, one needs to investigate a certain API request. This account is not used for any other purpose in Nepton other than the API. Minimum access to Nepton is recommended for this account for security reasons. For example, if the API implementation does not utilize HR data, then minimum role for accessing the HR data should be granted.
API deployment for data exports
When exporting, for example, projects or events from Nepton, in addition to the settings above, integration rulesets which define the content of the exports, are needed.
Nepton API is included in all Nepton service levels.