Link Search Menu Expand Document

Obtain the actual details and update the details below)

Matrix Realtime data gateway API

This API allows you to enable access to realtime data.

Operations available in this API:

  1. datagateway.Connect:
    1. Allows you to connect to the data gateway endpoints offered by Matrix.
    2. Currently, only available for region: Asia/Singapore (SIN)
  2. datagateway.publishRequest:
    1. Allows you to submit a request to publish your payloads.

Request Path:

apis.smartclean.rtdatagateway

Endpoint:

Method: POST
Type: application/json
URL: /v1/actions

Headers:

Key Value Description
Authorization   (Required) The Access Token or HMAC Signature
x-sc-auth external (Optional)

Body:

{
  "Attribute1": "Attribute 1 Value",
  "Attribute2": "Attribute 2 Value"
}

Request body parameters

Key Description
Attribute 1 (Required) Description for attribute 1
Attribute 2 (Required) Description for attribute 2

More example Requests/Responses:

1. Example Request:

Body:

{
  "Attribute1": "Attribute 1 Example Value",
  "Attribute2": "Attribute 2 Example Value"
}
1. Example Response:
{
  "responseAttribute1": "ValueOfResponseAttribute1"
}