|
<< Click to Display Table of Contents >> Navigation: Settings > Settings - Integrations |
Automatically translated from Dutch. Some wording may be inaccurate.
Regelneef API
The API lets external applications exchange data with your Regelneef database. You control whether the API is available and what access each integration receives.
Enable Regelneef API
The Enable Regelneef API checkbox is the master switch for all API integrations. When it is off, API access is blocked even with a valid API key. Enable it only when you intend to use the API.
Managing API keys
Use Manage API keys to manage the keys that give integrations access. We recommend a separate key for each integration, with a recognisable name that describes its purpose. This lets you change or revoke access separately.
For each key, set the required permissions: Read, Write and/or Import Inbox. Grant only the permissions the integration needs.
The overview shows who created each key, its status and permissions. Last used shows the date and time of the most recent API call made with that key, helping you see whether and when an integration is used.
Treat API keys like passwords: store them securely and share them only with the party responsible for that integration. Revoke a key when the integration is no longer needed or if you suspect unauthorised access to it. Other integrations using their own keys remain available.
Technical documentation
Use Documentation to open the technical documentation. Share it with your software supplier or developer when arranging an integration.
Known databases
Register another Regelneef database as a known database to send XML export files to it easily. Choose New in the overview, then enter an API key for that database and a clear name.
The Export employees screen then shows an Import Inbox button when the Regelneef employee XML format is selected. Choose a known database to send the file to its Import Inbox.
Regelneef web forms
SunBase can create and host a custom online form for your organisation, such as a registration form with document uploads. These forms have addresses starting with app.regelneef.net.
Regelneef can also help you fill in such a form. Register its web address in the Web forms table, together with the export profile used to supply the correct certificate names.
A Web form button then appears in Export employee. It opens the form and automatically fills in the selected employee's details.
File locations
Save export files in
The export modules write their files to this default path.
Read import file from
The export modules read import files from this default path.
Freepack export
If bank details are maintained primarily in Freepack, clear Export bank account data from employee. Regelneef then leaves bank details out of export files, preventing accidental overwrites in Freepack.
If WGA deduction at employee is enabled, exports to Freepack always set this to Yes. Otherwise, Freepack's default applies.
Enable Student only when employees marked as students in Freepack are also marked as such in Regelneef.
To prevent employees without personnel numbers from being exported to Freepack, enable Only export employees that have an employee nr. Regelneef validates this before exporting.
Enable Regelneef Transporter to simplify file transfers to and from Freepack. Extra options then appear in the import and export screens.