logoDocument
Search

REST API Overview

Basic Constraints

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

Data Center and Base URL

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

When using the REST API, you need to combine the selected base URL with the specific API path to obtain the complete call address.

{base URL}/{API Path}
              
              {base URL}/{API Path}

            
This code block in the floating window

Authentication

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 generation algorithm for the above base64_auth_string is: base64(api_key:api_secret)

  • The Header name is "Authorization", and the value is the base64 encoded "username:password" pair (separated by a colon).
  • In the context of LiveDesk API, username is the API Key, and password is the API Secret. Please add an API type data source in "Project Settings - API Management" to obtain the API Key and API Secret.
icon
Contact Sales