⚠️ Available in Professional package. Interested? Please e-mail us at sales@peopleforce.io to find out more.
In this article, you will find a step-by-step guide on how to integrate using the API. The integration process is divided into 3 main stages: generating API key, choosing the request, and practically try it out.
⚠️ Please note that only users with Administrator roles can perform these actions.
Step 1
To generate a new API key, go to Security Settings and click on the "API Keys" icon located at the bottom field area.
Click + New
Enter the Name of the key.
Select the Type of key:
Company – provides full access to your organization’s data.
Career – limited-access key for integrating your career site or job board.
Define permissions if needed.
If needed, specify Whitelisted IP addresses.
Click Generate to create the key.
Once created, the API key appears in the list. Copy this token, you will need it a bit more further.
You can enable or disable keys using the toggle switch next to each key, allowing you to temporarily deactivate integrations without deleting them.
Step 2
Access the complete list of available API requests. You can find the API keys page by clicking on the word “here” or by the link.
After clicking the "API references" button, a new tab will pop up in your browser where you can find the most popular API requests for Jira, PowerBi, 1C, and more.
The most popular requests are:
Each request regarding the position of the employee
The full list of the locations
Step 3
To access the code, kindly select your preferred language from the options available on the right-hand side of the page. Insert the token from the first step into the authorization field. Then, click the "Try it!" button located at the bottom of the code. If the API is set up correctly on your end, the code will return a "200" status.
You or your system administrator/DevOps can accomplish this task using the Postman app.