Skip to main content

monoZ:Link API

Introduction​

The monoZ:Link is service which receives data in various supported protocols it then transforms the protocol and pushes the data to the receiver in the destination protocol. The service provides closed network security on the source side, handles protocol translation to take advantage of low data usage of an unsecured network at the source side while using the secured protocols on the destination side. The document describes the REST APIs exposed by the monoZ:Link service.

Terminology​

The table below describes the standard terminology used throughout this API Documentation:

APIApplication Programming Interface
RESTRepresentational State Transfer, and HTTP base architecture for data transfer.
JSONJavaScript Object Notation, a data structuring format.
IoTInternet of Things.
MQTTMessage Queuing Telemetry Transport.

REST API Description​

The following are the REST APIs and their usages. In the below API description we will use the sample Instance, Version & Organization ID as shown in the example in section 3 above. They will be:

Instance: https://link.monoz.io/api
Version: v1
Organization ID: mti

We will use a sample ICCID and dummy API Key for authentication as mentioned in section 3.1.

ICCID: 1234567890​
API Key:​
Key: X-API-Key
Value: abcdefgh123456

We will use cURL Command to show sample usage and we will show some sample data in API call return and explain the return data as well as any arguments to the API call. Every API returns a JSON object as the response. The JSON object returned with each API is described in the sections below. Every JSON object contains a standard response format consisting of:

  • Error: Has a value of True/False denoting whether there was any error in processing the request.
  • Message: A message describing what was the error if any.
  • StatusCode: The standard HTTP Response Status Code.
  • Data: The optional node where a data structure specific to the API is added.

Every record is associated with an Organization hence each API call needs the Organization ID to be provided. The.g.,ET APIs take the Organization ID in URL Path while the PUT/POST APIs take them as part of request body.