MonQcle API
 v1 
OAS 3.0

The MonQcle APIs provide access to published project and dataset data, enabling seamless integration and utilization of this data within third-party applications. To initiate the use of MonQcle APIs, you must obtain two distinct tokens: an Organization Token and a Site Token.

To acquire the Organization Token, please submit a request to the MonQcle administrator. Additionally, to obtain the Site Token, Organization Administrators can generate it by accessing the "Edit Site" option in the site menu.

After obtaining both your Organization Token and Site Token, there are two methods for submitting requests: through the user interface (UI) and via a third-party application. Please refer to the detailed steps outlined below for each approach.

Requests through the UI:

  1. Enter your Organization Token in the X-Organization-Token field.
  2. Select "Authorize" after inputting the Organization Token.
  3. Enter your Site Token in the X-Site-Token field.
  4. Select "Authorize" after inputting the Site Token

Requests through a third party (e.g., Postman):

  • X-Organization-Token: Your Organization Token goes here!
  • X-Site-Token: Your Site Token goes here!

Once these two items are successfully passed as headers, you will be able to execute sample requests.

JavaScript Example

fetch(https://extapi.monqcle.com/master/jurisdiction/types', {
  headers: {
    'Accept': 'application/json',
    'X-Organization-Token': '<Your Organization Token goes here!>',
    'X-Site-Token': '<Your Site Token goes here!>',
  }
})
.then(data => console.log(data))
.catch(error => console.log(error))

The below table defines the HTTP Status codes that this API may return

Status CodeDescriptionReason
200OKIf the request is success.
400BAD REQUESTIf the request is not valid.
401UNAUTHORIZEDIf the credentials are invalid.
404NOT FOUNDIf the request is not found.
500INTERNAL SERVER ERRORIf the request has internal server error.
Servers

Master Data