QUICKOM For Developers Introduction

This document lets you understand how does QUICKOM Rest Api Platform work.

General Information

All endpoints return either a JSON object or array.
All time and timestamp related fields are in milliseconds.
HTTP 400 return codes is used for invalid data.
HTTP 401 return codes is used for unauthorized request.
HTTP 404 return codes is used for data not found.
HTTP 405 return codes is used for wrong api method.
HTTP 406 return codes is used for not acceptable data.
HTTP 429 return codes is used when there are too many requests attack on the same data.
HTTP 500 return codes is used for invalid format request or wrong from server’s side.
Any endpoint can return an ERROR, the error payload is as follows:

{
  "error" : "429001",
  "error_description" : "Too many requests"
}

For GET endpoints, the parameters may be sent as a request param or not.
For POST and DELETE endpoints, the parameters must be sent as a request body with content type application/json.
Parameters may be sent in any order.

All endpoints were protected by an Authorization.
Authorization is your api key and can be passed into REST Api via Authorization header.