What is an Open API?
An Open API is an API that is publicly available for anyone to use. It allows developers to access certain features or data from a service and integrate them into their own applications.
Nectar's Open API
Nectar's Open API currently has limited endpoints able to be accessed. The endpoints available are:
Financial Reports
User Upsert (can get and put data) = gather user data and create users
Setting up the API
If you are not able to access the API settings this feature is probably not included in your plan with Nectar. Please contact your account manager to have it added.
To set up the API, you will go to Settings > Integrations and scroll down to API Integration
You can create up to one API key for your account.
Click the Generate API Key button.
Set an Expiration Date or leave blank for no expiration.
Select the Scopes for the API, then click Generate API Key.
❗ Please note: The key will only be shown once and should be copied and saved in a secure location/device. If the key is lost, the API Key will need to be regenerated.
You can use the generated key on the Public API Docs (https://api.nectarhr.com/docs). Swagger provides a way to securely test the API. Be assured that while you will paste your key into the UI, it is only stored locally, and only sent to our servers for authentication.
The admin that created the API Key will be listed in the Key record, along with the date it was generated, its expiration date, and a “Key bit” these are the last 5 characters of the generated key, and can be used by the your team to identify which key you're managing.
By clicking the three dots on the right, you can temporarily enable/disable or permanently delete a key.
If you delete the key, this action cannot be reversed.
Things to note:
You will need to provide the generate key with every request you make to the API.
You can have up to 50 calls at a time with the API.
Nectar has very limited resources for the API past providing the ability to generate the key for the endpoint.
Any admin that has access to the integrations page can manage, create, and delete API Keys.