0% found this document useful (0 votes)

76 views

FrontDeskID API v2

The FrontDeskID API provides endpoints for authentication, creating meetings with QR code sync to Biostar, managing visitor companies, departments, and employees. It supports authentication via Active Directory credentials or system credentials to obtain a token. A key endpoint creates a meeting, syncs the QR code to Biostar, and sends email/SMS notifications. Other endpoints provide lists of companies, departments, meeting types, and employees by department.

Uploaded by

Asim

Available Formats

Download as DOCX, PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

76 views

FrontDeskID API v2

Uploaded by

Asim

Available Formats

Download as DOCX, PDF, TXT or read online on Scribd

You are on page 1/ 7

AGILE DATA SYSTEMS

APIs, Analytics & User-Focused Apps

FrontDeskID API

Prepared by: Asim Shahzad

20th Nov 2023
v1.0

© 2021 AGILE DATA SYSTEMS 1

FrontDeskID – Integration API v1.0
Table of Contents

FRONTDESKID API....................................................................................................3

1. API HOSTNAME (URL)....................................................................................................................... 3

2. AUTHENTICATION ENDPOINT..................................................................................................................................... 3
1.1. WINDOWS/ AD AUTHENTICATION.......................................................................................................................................... 3
1.2. SYSTEM CREDENTIALS..................................................................................................................................................................... 4
3. CREATE MEETING WITH QR SYNC TO BIOSTAR.................................................................................................. 4
4. GET VISITOR COMPANY LIST...................................................................................................................................... 6
5. ADD COMPANY.................................................................................................................................................................. 6
6. GET DEPARTMENT LIST................................................................................................................................................ 7
7. GET EMPLOYEES BY DEPARTMENT........................................................................................................................... 7
8. GET MEETING TYPES...................................................................................................................................................... 7

© 2021 AGILE DATA SYSTEMS 2

FrontDeskID – Integration API v1.0
FrontDeskID API

FrontDeskID API is RESTFUL web service to integration the key features with
internal systems.

1. API hostname (URL)

API hostname or URL is available in FrontDesk application settings. Below is the SQL
query to get the hostname from FrontDesk system database.

select AS_Value from AppSettings where as_code = 'API_URL'

2. Authentication Endpoint
The API allows multiple ways of authentication. Firstly, the authentication
mechanism using Active Directory credentials and returns the token for mapped
user profile. Secondly, authenticate the user FrontDesk system credentials and upon
successful authentication, API will return token. The token will be used in other
endpoints as means of authorization.

1.1. Windows/ AD authentication

The below is the simple call with windows authentication to create a token for user:

Endpoint: {{URL}}/Token/WindowsLogin

Request Payload:

{
"username": "username",
"password": "password",
"ldapip": "1027.0.0.1",
"domain": "frontdeskid",
"port": 389,
"isSecureSocket": false
}

Response Payload:

{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmYW1pbHlfbmFtZSI6ImZhbGR1YXlqaSIs
ImdpdmVuX25hbWUiOiJBYUAxMjMzMzIxISMjNCQkNDQiLCJ1bmlxdWVfbmFtZSI6IkZhZGhlbCBBbCBEdWF5amk

© 2021 AGILE DATA SYSTEMS 3

FrontDeskID – Integration API v1.0
iLCJleHAiOjE2MjU0NDgyMjIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6NjM3NzYvIiwiYXVkIjoiaHR0cDovL2
xvY2FsaG9zdDo2Mzc3Ni8ifQ.OdM1ck6gD4VO1BEsiM8anUTCwfcEjeSaL3FCEwv6rXg",
"expires": "2021-07-05T04:23:42.535372+03:00",
"userId": 45,
"userFullNameEng": "Admin",
"userFullNameArb": "Admin"
}

1.2. System Credentials

The below is the simple call with FrontDesk system authentication to create a token
for user:

Endpoint: {{URL}}/ Token/CreateUserToken

Request Payload:

{
"username": "svc_bio",
"password": "P@ssw0rd"
}

Response Payload:

{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmYW1pbHlfbmFtZSI6ImZhbGR1YXlqaSIs
ImdpdmVuX25hbWUiOiJBYUAxMjMzMzIxISMjNCQkNDQiLCJ1bmlxdWVfbmFtZSI6IkZhZGhlbCBBbCBEdWF5amk
iLCJleHAiOjE2MjU0NDgyMjIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6NjM3NzYvIiwiYXVkIjoiaHR0cDovL2
xvY2FsaG9zdDo2Mzc3Ni8ifQ.OdM1ck6gD4VO1BEsiM8anUTCwfcEjeSaL3FCEwv6rXg",
"expires": "2021-07-05T04:23:42.535372+03:00",
"userId": 45,
"userFullNameEng": "Admin",
"userFullNameArb": "Admin"
}

3. Create Meeting with QR Sync to Biostar

This integration will be invoked from REST to save meeting  execute the EndPoint provided by
FrontDeskID using REST connection that return the success of the meeting is saved successfully.

Integration Structure

 Triggering Event:
The integration “api/Meeting/add” is triggered by direct invocation using its exposed
REST API.
o Create new meeting

© 2021 AGILE DATA SYSTEMS 4

FrontDeskID – Integration API v1.0
o Create and Sync QR code with Biostar
o Send Notification to Host and Visitor by Email
o Send Notification to Host and Visitor by SMS

 Service Input:
The integration input is the standard JSON payload.

 Tracking Variables:
method

 Connections:
Connection Name Adaptor Description
Name
api/Meeting/add REST Entry point for the integration  Exposes
endpoint

Endpoint URL:
https://[hostname]/api/Meeting/add

Method: POST

Request Body:

{
"sessionID": 1,
"meetingID": 1,
"meetingEmployeeIDs": "10086",
"meetingVisitorName": "Shajar Abbas",
"meetingVisitorEmail": "[email protected]",
"meetingVisitorPhone": "966501234567",
"meetingStartTime": "2021-07-01 08:00:00",
"meetingEndTime": "2021-07-01 08:00:00",

FrontDeskID – Integration API v1.0
"meetingTypeID": 7,
"meetingPurpose": "Mention the purpose of meeting",
"meetingUSRGroup": "Access group name that you want to assign"
}

Response Body:

{
"status": "OK",
"message": "success",
"response": {
"status": "success",
"messageEng": "Meeting is scheduled successfully.",
"messageArb": "‫بنجاح اجتماع عقد المقرر من‬."
}
}