RestAPI Overview
Basic Constraints
- The API is designed to comply with HTTP and RESTful 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 parameters should be encoded 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 specific API path 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 base64_auth_string is generated using the following algorithm: base64(api_key:api_secret).
- The header name is "Authorization", and the value is the base64--encoded "username:password" pair (with a colon in the middle).
- For the MA API, the username corresponds to the APIKey, and the password corresponds to the APISecret. Please configure an API-type data source to obtain the APIKey and API Secret.
