REST API OVERVIEW

Basic constraint

• The API is designed to conform to HTTP and REST specifications. For example, the query request uses the Get method, and the submission request uses the POST method. If a request is not a corresponding HTTP method, an error will be returned.
• Unless otherwise specified, the call parameter value should be transcoded as UTF-8, URL encoding.

Data Centers and Base URL

Starting from March 19, 2025, developers who newly access the Engagelab Push API are requested to use the following domain name. The original Base URL with the .cc suffix can still be used, but developers are advised to switch to the latest domain name.

When using REST API, it's necessary to combine the selected base URL with the specific API path to obtain the complete endpoint.

          {base URL}/{API path}

        

Here, {base URL} represents the chosen data center's base URL, and {API path} denotes the specific API endpoint path, such as v4/devices/{registration_id}.

Example:

• Suppose the Singapore data center is selected with a base URL of https://pushapi-sgp.engagelab.com.
• If the goal is to delete registration information for a specific device, and the API path is v4/devices/{registration_id}, then the complete API endpoint would be:

          https://pushapi-sgp.engagelab.com/v4/devices/{registration_id}

        

Here, {registration_id} represents the specific device's registration ID.

Using this approach, you can construct complete API endpoint URLs for accessing different data centers.

Authentication method

The Engagelab REST API uses HTTP basic authentication. The basic approach is to add Authorization to the HTTP header:

          Authorization: Basic base64_auth_string

        

base64_ auth_ String generation algorithm:base64(appKey:masterSecret)
The string composed of appKey, colon and masterSecret and convert by base64.
Go to AppPush Page and get the AppKey and Master Secret infos in the APP Info Page.

Authentication example

Your appKey is "c96f42e0d2e662e45d035ab1", masterSecret is "df4d59e84eac2f9d53b36f12"，calling the Push API v4 by via curl command like below:

           curl --insecure -X POST -v https://pushapi-sgp.engagelab.com/v4/push 
-H "Content-Type: application/json" 
-u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" 
-d '{
    "from": "push",
    "to": "all",
    "body": {
        "platform": ["android","ios"],
        "notification": {
            "alert": "Hi,MTPush !",
            "notification": {
                "alert" :"Hello, Push!",
                "android": {
                    "alert": "Hi, Push!",
                    "title": "Send to Android",
                    "builder_id": 1,
                    "extras": {
                        "newsid": 321
                    }
                },
                "ios": {
                    "alert": "Hi, MTPush!",
                    "sound": "default",
                    "badge": "+1",
                    "extras": {
                        "newsid": 321
                    }
                }
            }
        }
    },
    "request_id": "12345678",
    "custom_args": "business info"
}'

        

HTTP Request example：

          > POST /v4/push HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==