REST API Overview

Basic Constraints

  • The API is designed to comply with HTTP and REST specifications. For example, query requests use the GET method, while submission requests use the POST method. If a request does not use the corresponding HTTP method, an error is returned.
  • Unless otherwise specified, parameter values in requests must be encoded in UTF-8 using URL encoding.

Data Center and Base URL

Data Center Base URL
Singapore https://livedesk-api.engagelab.com

When using the LiveDesk REST API, combine the selected base URL with the path of the specific API to obtain the complete request URL.

{base URL}/{API path}
              
              {base URL}/{API path}

            
This code block in the floating window

Authentication Method

The EngageLab REST API uses HTTP Basic Authentication. Add Authorization to the HTTP header:

Authorization: Basic ${base64_auth_string}
              
              Authorization: Basic ${base64_auth_string}

            
This code block in the floating window

The algorithm for generating base64_auth_string is:

base64(api_key:api_secret)
              
              base64(api_key:api_secret)

            
This code block in the floating window
  • The header name is Authorization, and its value is the Base64-encoded username:password pair, separated by a colon.
  • In the LiveDesk API context, the username is the API Key, and the password is the API Secret. Add an API-type data source under Project Settings > API Management to obtain the API Key and API Secret.
Icon Solid Transparent White Qiyu
Contact Sales