Our REST API and Console App are automated HR data sync tools that you configure and run on your own workstation or server.
The main differences between REST API and Console app:
- REST API is slightly more technical to setup and requires your IT department, but it can run fully automated on a server
- Console app can be installed by a technically savvy admin on their own workstation without IT involvement, but it must be manually run by an admin or IT every week or month
Warning!
When you enable HR Data Sync it will immediately disable the manual employee management tools. Any data changes must be made in your Human Resources Information System (HRIS) and cannot be updated manually. However, some data must always be updated manually (i.e. Start date and Birthday).
Good to know
- Every cycle re-syncs your entire HRIS roster of active employees
- Inactive employees are excluded from the sync, and newly inactivated/terminated employee accounts are automatically deleted during the next sync cycle
- We highly recommend you create a Technical User account to allow easy access to API keys, error files and to receive notification emails
- If your program is already live, we suggest that you contact your account manager so we can setup another system for your technical team to test with
Upload XML files using our REST API
Your IT team would need to do the following:
- Create an XML employee file
- Create an XML position file (if appropriate)
- Build a script that uploads the files to our REST API on a regular basis (nightly, weekly, or monthly)
- See How to upload your HR data using the REST API for more information
Upload CSV file using our Console app
You or your IT team would need to do the following:
- Create a CSV file containing your employees
- Install our Console App on a server or workstation
- Use the Console App to upload the CSV file on a regular basis (nightly, weekly, or monthly)
- See How to upload your HR data using our Console app for more information
Comments (0 comments)