Open APIs for Integrating with Jisr

The purpose of availing these APIs: 

Having a set of JISR public APIs will facilitate getting data from Jisr to be utilized by 3rd parties and to ease and expedite the integration process.

The currently available Open APIS: 

Category	API	Purpose
Authentication	Get the access token for the API	This API is used to generate Access-Token to access open API on the system based on permissions assigned to API key
Attendance	Get attendance summary	This endpoint retrieves the attendance summary for employees within a specified date range default is the current month. The request can be filtered by employee ID, status, from date/ to date, page, and (rpp) results per page
Attendance Log	View attendance records	This API endpoint retrieves the status of punches whether it's failed or successful.
	Create group of attendance Log	This API endpoint creates group of punches
Employees	Get Employee Basic Information	This API is used to get basic information of specific employees "at an individual level"
	Get List Employees	This API is used to get all active employee's basic information "as a Bulk"
	POST Create Employee	This API is used to create/add new employee on Jisr system through any ATS=Application Tracking System to have all their information automatically reflected on Jisr
Employee Leave	View summary of employee annual leave	This API endpoint retrieves the summary of employee annual leave.
Finance	GL transaction Types	This API endpoint retrieves all the GL transaction Types within the organization.
	Payroll transactions	This API is used to list all the payroll transactions. These are supported types:- Pay run (regular). Final settlements. Vacations settlements. Out off payroll transactions.

For further technical details to integrate with Jisr using these Open APIs, please click on the below detailed technical postman documentation URL: 

Technical postman documentation URL 

To start with the integration process, we need to generate the API key that would allow the developer to work on the target API needed to either GET OR Post information on Jisr as per the above listed Open APIS

Steps to Generate API Key (Authentication Flow): 

1. The user has to be an "Admin" on Jisr system in order to generate the API keys and Secrets

 2. Go to settings and click on API Keys Tab

3. Click on Add NEW API Key button as shown on the below screenshot 

4. Fill in all data needed as shown on the below video: 

The data required to generate the API Keys are as follows: 

• API Key Name 

• Under Employees Section, select a set of APIs to be exposed to the developer who will use that key. 

Note: 

Any unchecked API will not be open to the developer.

• Under Lookups, select the lookups that you would like to fetch the data from on Jisr to ensure proper data synchronization 

5. Click on Generate to be provided with the API Key & Secret 

6. API key and secret can be copied by the user who created them and shared with the developer to be used for any purpose by clicking on the "Copy" button as shown on the above Video 

Note: 

The API Secret can be copied ONLY once

7. List should show the created API keys and secrets so that the user can search, edit & add new keys to them.

Note: 

Take into consideration that the editable fields are hereunder listed: 

• API Key Name 
• APIs to be exposed to the developer 
• List of Lookups 

It is a new technical tool that enables direct and automatic integration between the "Jisr" system and external accounting systems (such as ERP software).

 

Note: Users can upload and export accounting entries via the API.

Accounting entries can also be downloaded as Excel files for review before exporting.

Related articles:

How to use Webhooks functionality

User Guide to activate Foodics Integration