Rest API

5min

REST API Host
Sandbox: https://mqdev.qualetics.com﻿
Live: https://mq.qualetics.com﻿
Generate JWT Token
EndPoint
/api/token
Authorization
Basic Authentication
Method
GET
Params
APPLICATION_ID - This will be the unique ID for the application that will be streaming the data. Multiple Application IDs can be generated for the same account.
APPLICATION_SECRET - Password for the application
Result
Access_Token
Send Message
EndPoint
/api/sendmessage
Authorization
Bearer <Access_Token>
Method
POST
Params
client_id - This should be the name or the unique identifier of your client in a multi-tenant setup for whom you are sending the data. If you do not have a multi-tenant setup then this value can be skipped.
Required for multi-tenant setup
Body
This contains the main message content that should be passed to the API. The message should be formatted as a JSON structure similar to the JS SDK for each event. See example Body content below
Result
Confirmation message
Example Code
JS
|
var settings = {
"url": "https://mqdev.qualetics.com/api/sendmessage",
"method": "POST",
"timeout": 0,
"headers": {
"Authorization": "Bearer <Access Token>",
"Content-Type": "application/json" },
"data": JSON.stringify({
    "actor": {
      "type": "Student",
      "id": 127,
      "attributes": {
        "student": {
          "name": "Test User"
        }
      }
    },
    "action": {
      "name": "New User"
    },
    "context": {
      "name": "New User",
      "attributes": {
        "position": "Accountant",
        "department": "Accounting",
        "location": "New York"
      }
    },
    "result": "None",
    "metadata": {
      "localtimestamp": "2022-01-26 13:40:47.288356",
      "userAgent": "None"
    }
  })
};


$.ajax(settings).done(function (response) {console.log(response);});
var settings = {
"url": "https://mqdev.qualetics.com/api/sendmessage",
"method": "POST",
"timeout": 0,
"headers": {
"Authorization": "Bearer <Access Token>",
"Content-Type": "application/json" },
"data": JSON.stringify({
    "actor": {
      "type": "Student",
      "id": 127,
      "attributes": {
        "student": {
          "name": "Test User"
        }
      }
    },
    "action": {
      "name": "New User"
    },
    "context": {
      "name": "New User",
      "attributes": {
        "position": "Accountant",
        "department": "Accounting",
        "location": "New York"
      }
    },
    "result": "None",
    "metadata": {
      "localtimestamp": "2022-01-26 13:40:47.288356",
      "userAgent": "None"
    }
  })
};


$.ajax(settings).done(function (response) {console.log(response);});
﻿
﻿

Updated 03 Mar 2023

Did this page help you?

TABLE OF CONTENTS

EndPoint	/api/token
Authorization	Basic Authentication
Method	GET
Params	APPLICATION_ID - This will be the unique ID for the application that will be streaming the data. Multiple Application IDs can be generated for the same account. APPLICATION_SECRET - Password for the application
Result	Access_Token

EndPoint	/api/sendmessage
Authorization	Bearer <Access_Token>
Method	POST
Params	client_id - This should be the name or the unique identifier of your client in a multi-tenant setup for whom you are sending the data. If you do not have a multi-tenant setup then this value can be skipped. Required for multi-tenant setup
Body	This contains the main message content that should be passed to the API. The message should be formatted as a JSON structure similar to the JS SDK for each event. See example Body content below
Result	Confirmation message