SSO Integration Requirements:
- Dummy login/credentials for the client’s LMS or the platform to be integrated.
- SSO user needs to pass below parameters -
- company_id - It is an ID provided by the Awarathon team. This is unique for each sub-domain.
- employee_code - It is a unique employee code from the client’s data, which is already integrated into the Awarathon platform.
- Using the provided information, Awarathon authenticates users and allows access to the platform without entering credentials.
- Sample Format For Rep: https://pwa.awarathon.com/web.html?company_id=company id&employee_code=encrypted_emp_code
- Sample Format For CMS: https://company_name.awarathon.com/login/sso/encrypted_emp_code/encrypted_company_id
- Before running this integration, kindly contact your PoC.
- We are using secure SSO i.e. Employee ID needs to be encrypted. Encryption method to be used: base64_encode().
User Integration Requirements: The system required basic information to run the application is mentioned below:
- Employee Code - It is a mandatory
- Salutation - Optional information
- First name - It is a mandatory
- Last name - It is a mandatory
- Date Of Joining - Optional information
- Reporting Manager - It is a mandatory
- Email - It is a mandatory
- Mobile number - Optional information
- Department/Division - It is a mandatory
- Designation - Optional information
- Reporting Admin - Optional information
- Level No - Optional information
- Level - It is a mandatory
- HQ(Headquarters) - It is a mandatory
- Area/Zone - It is a mandatory
- Region/Branch - It is a mandatory
- Status - To store employee active or inactive status. It is mandatory.
Our system can import the above-mentioned information using a REST API or an Excel file
- REST API - The system will use this approach when a client wants to update employee details regularly.
- On our server, we have integrated a script to upload information every night at a particular time.
- To import data, we need information from a client like API link, function name, and parameters required to call API. e.g. token, payload, username, and password.
- Generally, we test client API using a Postman application, once API runs successfully using Postman then we will integrate it into our system.
- Excel - The system will use this approach when a client wants to update employee details for a single-use or one-time.
- Excel should have the above-mentioned fields, if any fields/columns are optional or information is not available then keep them empty but please specify all fields in columns.
Here is the brief for FTP : FTP (File Transfer Protocol) is a network protocol for transmitting files. One can connect to the server through FTP via code or tool to access files. In our case, we are using FTP to provide a seamless process for our client to import user data into our system.
- Awarathon will provide one server path and FTP credentials to the client.
- Clients can use this folder to upload user data in Excel or CSV format (the file format and filename should be pre-decided between Awarathon and the client). From this file, user data will automatically sync in the Awarathon's system every midnight (once a day).
- For sample format, please click here
FTP Integration Requirements: The system required basic information to import the user data is mentioned below:
- Employee Code - It is a mandatory
- Salutation - Optional information
- First name - It is a mandatory
- Last name - It is a mandatory
- Date Of Joining - Optional information
- Reporting Manager - It is a mandatory
- Email - It is a mandatory
- Mobile number - Optional information
- Department/Division - It is a mandatory
- Designation - Optional information
- Reporting Admin - Optional information
- Level No - Optional information
- Level - It is a mandatory
- HQ(Headquarters) - It is a mandatory
- Area/Zone - It is a mandatory
- Region/Branch - It is a mandatory
- Status - To store employee active or inactive status. It is mandatory.
