An API is a way for another system such as your HRIS to communicate with Appraisd over the internet.
Appraisd has an API that is available to all customers at no extra fee. Our API follows REST principles with a JSON payload and response.
Can I integrate Appraisd with my HRIS / HRMS?
We have ready-made integrations with Zenefits and BambooHR. If you use either of those, then contact support@appraisd.com for information on how to get them set up. If not, read on.
If your HRIS has an API or has the capability of interacting with an API, then it's highly likely that you can sync data from your HRIS to Appraisd.
In practice this typically means whenever you add a new employee or make a change to an employee on your HRIS, the same employee will be added or modified on Appraisd almost instantly. This saves you the admin time of making the changes twice and helps to ensure your Appraisd account is always up to date.
Please note that integration is not the same as Single Sign On, which allows users to log in to Appraisd without needing a separate password .
In some cases, you may need to write a small programme to connect your HRIS with Appraisd. Thanks to our API documentation this should be straightforward.
Less straightforward is data that relates to reviews or objectives and syncing it between the two systems - that's because this data is more complex and needs to be 'translated' to suit the target system.
What's available?
At the moment, the API includes the following areas:
Activity Log
- List recent actions on Appraisd taken by your users (logged in, such as submitted a review, edited a user)
Users
- Search or list your existing users
- Add new users or make changes to existing users
- Deactivate users
Your account (these features are in beta and URLs may change)
- Get a list of forms in your account
- Get a list of Job Descriptions in your account
- Get a list of the workflows enabled on your account
- Get a ZIP of all reviews, objectives and user data
- Get a list of Administration Groups on your account
Reviews
- Add an appraisal/review/check-in
- Delete an appraisal/review/check-in
- Update an appraisal/review/check-in
To gain access to our API, please email support@appraisd.com
Sandbox
You are welcome to sign up for a free trial of Appraisd to set up your own sandbox account at no cost. Sign up at www.appraisd.com with an alternative email address.
Documentation
Interactive documentation is available here: https://api.appraisd.com/docs/index.
Please also refer to User provisioning using the Appraisd API.
Authorisation
Access to our API is gained by passing an API token in the header of your request in this format:
Authorization: Bearer {token}
Comments
0 comments
Please sign in to leave a comment.