Skip to content

API Introduction

The jetQuery API is built on HTTP and follows a RESTful architecture. It provides the following features:

  • Uses predictable, resource-oriented URLs.
  • Utilizes built-in HTTP capabilities for passing parameters and authentication.
  • Responds with standard HTTP response codes to indicate errors.
  • Returns data in JSON format.
  • Implements Token Based Authentication for secure access.

Path Conventions

The general structure of API paths is as follows:

/api/{{area}}/{{module}}/{{action}}

  • {{area}} - Represents the core, srs, erp, crm, etc.
  • {{module}} - Represents the specific module such as account, system, apps, connections, storage ,files etc.
  • {{action}} - Represents the action to be performed, such as browse, delete, update, create, etc.
Route Description
/api/* api/core, api/srs, api/crm, etc.
/js JavaScript files managed by the system for compression, bundling, and automations.
/css CSS files managed by the system for compression, bundling, and automations.
/components Vue components managed by the system for compression, bundling, and automations.
/pages Vue pages managed by the system, with /pages/index.js serving as the entry point.
/assets Includes CSS, JS, fonts, and other assets not managed by the system.
/images Images.

Read more about router and paths

Optional parameters:

  • app_name optional application context, with the default being the current user.
  • ptoken optional API TOKEN see Authentication
  • pscope optional parameter for the parent scope (used in SRS).

Example API Request

HTTP
1
curl {{host}}/api/core/system/ping \
Response
JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "success": true,
  "message": "OK",
  "requestID": "",
  "executed_at": "2050-01-01T00:00:00.123456Z",
  "data": {
    "items": {
      "authenticated": false,
      "username": "[email protected]",
      "version": "0000"
    },
    "body": null
  }
}

Response codes

API returns standard HTTP response codes.

Code Description
200 Everything worked as expected
400 Bad Request (client error) - Missing a required parameter, malformed request
401 Unauthorized
403 Forbidden The request was valid, but the server is refusing action.
404 Not Found - The requested item doesn’t exist
413 Request Entity Too Large - Attachment size is too big
500 Something is wrong - Missing a required parameter, malformed request