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:
Requests through a third party (e.g., Postman):
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 Code | Description | Reason |
---|---|---|
200 | OK | If the request is success. |
400 | BAD REQUEST | If the request is not valid. |
401 | UNAUTHORIZED | If the credentials are invalid. |
404 | NOT FOUND | If the request is not found. |
500 | INTERNAL SERVER ERROR | If the request has internal server error. |