Integration
SSO Integration Requirements:
- To integrate Single Sign-On (SSO) with Awarathon’s platform, the client must provide dummy login credentials for their LMS or any other platform to be integrated.
- SSO Request Parameters -
- company_id - A unique identifier provided by the Awarathon team for each client.
- employee_code - The unique employee identifier from the client’s system, which is already mapped within the Awarathon platform.
- hmac_token - A secure token generated by encrypting the employee_code using HMAC (Hash-based Message Authentication Code).
- HMAC Token Generation -
- To ensure secure authentication, the employee_code must be encrypted using the HMAC algorithm. The encryption should follow this structure.
- hmac_token = hash_hmac('sha256', employee_code, secret_key)
- Secret key: A unique secret key provided by the Awarathon team for each client
- sha256: The recommended hashing algorithm
- Note: Do not share the Secret key publicly. It must be securely exchanged and stored.
- Using the provided information, Awarathon authenticates users and allows access to the platform without entering credentials.
- Sample Format: http://app.awarathon.com/sso-login/company_id/employee_code/hmac_token
- Upon receiving a valid request, Awarathon will authenticate the user and allow direct access to the platform without requiring additional login credentials.
User Integration Requirements: The system required basic information to run the application is mentioned below:
- Employee ID - It is a mandatory
- Salutation - Optional information
- First name - It is a mandatory
- Last name - It is a mandatory
- Email address - It is a mandatory
- Region - It is a mandatory
- Designation - It is a mandatory
- Division - It is a mandatory
- Role - It is a mandatory
- Country Code - Optional information
- Mobile number - It is a mandatory
- Employee ID Of L1 - It is a mandatory
- L1 First Name - It is a mandatory
- L1 Last Name - It is a mandatory
- L1 Email address - It is a mandatory
- HQ - It is a mandatory.
- Zone - It is a mandatory.
- Cluster - It is a mandatory.
- Registration date - Optional information
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).
