RestAPI Overview
Last updated:2025-03-18
Basic Constraints
- The API is designed to comply with HTTP and REST specifications. For example, use the Get method for query requests and the POST method for submission requests. If a request does not use the corresponding HTTP method, an error will be returned.
- Unless otherwise specified, the call parameter values should be transcoded to UTF-8 and URL encoding.
Data Centers and Base URLs
Data Center | Base URL |
---|---|
Singapore | https://ma-api.engagelab.com |
When using the REST API, you need to combine the selected base URL with the path of the specific API to obtain the complete invocation address.
{base URL}/{API path}
{base URL}/{API path}
This code block in the floating window
Authentication Method
The EngageLab REST API uses the authentication method of 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-converted "username:password" pair (with a colon in the middle).
- In the scenario of the MA API, the username is the APIKey, and the password is the APISecret. Please add a data source of the API type in the data source to obtain the APIKey and API Secret.