Documentation
API Integration CORE
Index
Index 2
Introduction 2
Main Documentation 2
Security: 2
Authentication 3
Data Injection Prevention 3
Response 3
Authentication 3
Core 3
People 4
User Management 4
Individual User Creation: 4
Mass User Creation: 4
User Listing: 4
User Activation and Deactivation: 4
Catalog Data 4
Hierarchical Structure Management (Areas) 5
Role Management 5
Position Management 5
Picklist Data 5
Recommended Usage Flows 5
With Positions: 6
Without Positions: 6
Endpoint Use Cases 6
Introduction
This guide is designed to support Rankmi clients in using our API by detailing the main use
cases and available integrations.
Main Documentation
● QA Environment: QA Documentation
● Production Environment: Production Documentation
Security:
Authentication
API security is ensured through the use of JWT (JSON Web Tokens) that are valid for 24 hours.
This guarantees that only authenticated companies can interact with the API, minimizing the
risks of unauthorized access.
Data Injection Prevention
The API includes restrictions to protect data integrity:
● POST Methods: Limit of 60 requests per minute.
● BULK Methods: Can process up to 100 users per request, with a limit of 60 requests
per minute.
Response
The response codes indicated follow the “HTTP Response Status Codes” standard:
[Link]
Authentication
To use the API, requests must be authenticated. The required parameters are:
● Required Parameters:
○ UID: Required
○ SecretKey: Required
○ TimeZone: Optional
The required parameters (UID and SecretKey) are provided by the Rankmi team. These
credentials are used for API authentication.
Endpoint Example: Authentication
Core
The Rankmi CORE module is the central hub for employee data management. It includes
managing personal information, employment data, and organizational elements such as
hierarchical structures, roles, and positions. This centralized system ensures the integrity and
availability of information for other connected processes and modules.
Additionally, this document details the functionalities and data that can be managed through the
API, including:
● Creating, updating, and listing users.
● Managing organizational hierarchies and areas.
● Administering roles and positions.
● Cataloging standardized data such as countries, languages, and employment modes.
People
User Management
Individual User Creation:
● Allows creating or updating a user per request.
● Endpoint Documentation
Mass User Creation:
● Allows creating or updating up to 100 users per request.
● Endpoint Documentation
User Listing:
● This endpoint enables listing users using filters such as:
○ Pagination.
○ Creation, entry, and update date ranges.
○ User status.
○ Specific user search.
● Endpoint Documentation
User Activation and Deactivation:
● Deactivation: Changes the user status to “Inactive.” Endpoint Documentation
● Reactivation: Changes the user status to “Active.” Endpoint Documentation
Catalog Data
Endpoint data Options
Active True | False
Gender F = Female
M = Male
O = other
Country ISO 3166-1 Alpha 2 code
Nationality ISO 3166-1 Alpha 2 code
Lang ISO 639-1 code (en,es,fr,pt,pl,de)
Hierarchical Structure Management (Areas)
● Create/Update Areas: Allows managing organizational areas. Endpoint Documentation
● List Areas: Supports specific searches using the “search” parameter. Endpoint
Documentation
Role Management
● Create/Update Roles: For administering roles within the organizational structure.
Endpoint Documentation
● List Roles: Supports filters and specific searches. Endpoint Documentation
Position Management
● Update Positions: Endpoint Documentation
● List Positions: Includes filters for creation and update dates. Endpoint Documentation
● Specific Search: Allows viewing position information using its token. Endpoint
Documentation
Picklist Data
Endpoint data Options
“critical_position” True | false
"employment_mode": { Values: 1 | 2 | 3
"value": 2, Label: on_site | remote | hybrid
"label": "Remote"
},
"status": { Values: 1 | 2 | 3 | 4
"value": 2, Label: scheduled | with_vacancies | busy |
"label": "With Vacancies" archived
},
Recommended Usage Flows
The following recommended endpoint usage flows describe two available implementation
methods:
With Positions:
1. Create areas.
2. Create roles.
3. Create positions.
4. Create users.
Without Positions:
1. Create areas.
2. Create roles.
3. Create users.
Endpoint Use Cases
Below is the download link for a Postman collection of the mentioned endpoints, including
correct usage examples:
Download Postman Collection