There are different ways to update your employee database and among them, our User management API.
This API will be useful if you have specific needs in adapting your HRIS data to fit Supermood, or simply want to automate the update while keeping 100% control.
|ℹ️ Technical documentation
Supermood APIs are external HTTP REST APIs. To browse the documentation, download our file Supermood API Documentation and simply paste its contents into Swagger Editor.
In this article:
🔎 About the User management API
An API is a set of protocols that is used to link two pieces of software together for an exchange of data and functionality. You can think of it as a group of building blocks that will allow your technical team to build a bridge between your HRIS software and Supermood.
In other words, it's what will allow you to create a custom integration, tailored to your needs.
The User Management API allows you to automatically update your employee database on Supermood, by injecting data from your HRIS or payroll software, for example.
You can search, add, modify or delete employees on Supermood.
💡 Pro tips
✨ Integration possibilities
- Meet specific needs
This API can be interesting if you want to automate the update process with unique internal operational needs.
For example, your technical team can work to integrate automatic advanced update rules such as 'if the employee's contract start date is in the future, then the employee is not added to the platform'.
- Integrate multiple HRIS
Your organization spans multiple countries and you need to manage several HRIS? Creating API integrations will give you the opportunity to standardize employee data for easy integration into Supermood.
💡 If you are integrating data from multiple HRIS, make sure there are no duplicates of employee personal identifiers from one HRIS to another.
- Reclaim time
Once the automation is in place, you only have one tool to update: your HRIS (or equivalent). The data from this tool will be used to feed your Supermood employee database.
No more monthly mass updates or manual adjustments: employee information is up to date from their first day in the company. This can be very helpful when setting up an onboarding survey!
💡 Depending on your HRIS and internal movements, you can choose to apply continuous, daily, weekly or monthly updates - tailoring Supermood data to your pace.
To benefit from the Survey answer API, your organization must have:
- an HRIS software or similar (payroll system, etc.), containing your employee's up-to-date hierarchical and demographic information;
⚠️ For fields updated via API, remember to make your changes in your HRIS and no longer in the Supermood platform. Changes from the platform (manual or via imports) will be overwritten by the API.
- A developer to create the integration from the documentation
🧰 Using Supermood's APIs
1. Request a test account
First, contact your Account Manager to get a test environment so that your teams can develop your integration safely.
Remember to include in this exchange the person responsible for setting up the API (often your CIO/ISD) so that they can be given admin access to the test account.
2. Create a service account
Once your test account is available, you (or your CIO, for example) will need to go to My account > Settings > Integrations. Here, create a service account by clicking on the "Add a service account" button. This service account will be necessary to the integration.
Be sure to save the username and password you are given at this step - as a security measure, they cannot be provided again.
💡If you are feeding data from multiple HRIS, we recommend creating one service account per HRIS. This will provide you with higher security and the ability to track the actions of each API separately if needed.
Safely transmit the service account info and the documentation below to your developer so they can create the integration and test it on the test account.
|ℹ️ Technical documentation
Once your integration is tested and approved, create a new service account from your main account (as seen in step 2.) and forward it to your developer so that they can implement the integration. 🚀
If you have any issue with our API, please feel free to reach out to us at firstname.lastname@example.org ! 💁♀️
Les APIs Supermood