Quick Consols Api Documentation

The Quick Consols API is intended to provide a standardized interface to import/export data to and from the Quick Consols environment. This is a RESTful API accepting data in JSON format.

Each request will return a ApiResponse object defined below.

UAT Base Url : https://quickconsolsqa.com/api/

PROD Base Url : https://quickconsols.app/api/

ApiResponse

Field	Data Type	Description
success	boolean	True if request was successful
message	string	Additional text about result of operation
code	string	Code representing success or failure of request
obj	object	Resulting object relating to request

Authentication

The API uses token-based authentication, each token is valid for 30 days.

Each api user will be provided with a username and password combination which will be used to make a request to the User/Login endpoint on the api.

If successful, this request will return a token in the obj field which will be required for all subsequent api requests.

The token will need to be supplied in the header with the name “token” (lowercase).

POSTLogin

https://quickconsolsqa.com/api/user/login

Verify API user and obtain access token (token will expire in 30 days)

ApiUserLogin

Field	Data Type	Description
username	string	username for api user
password	string	password for api user

HEADERS

Content-Type

application/json

Bodyraw (json)

json

{
    "username": "username",
    "password": "password"
}

Example Request

curl

curl --location 'https://quickconsolsqa.com/api/user/login' \
--header 'Content-Type: application/json' \
--data '{
    "username": "username",
    "password": "password"
}'

200 OK

Example Response

json

{
  "success": true,
  "message": "Login successful",
  "code": null,
  "obj": "xxxxxxx"
}

Cache-Control

no-cache

Pragma

no-cache

Content-Type

application/json; charset=utf-8

Expires

-1

Server

Microsoft-IIS/10.0

X-AspNet-Version

4.0.30319

X-Powered-By

ASP.NET

Access-Control-Allow-Origin

Access-Control-Allow-Headers

Content-Type

Access-Control-Allow-Methods

GET, POST, PUT, DELETE, OPTIONS

Date

Mon, 21 Aug 2023 14:11:08 GMT

Content-Length

GETRefresh Token

https://quickconsolsqa.com/api/user/refreshToken

Ability to refresh a valid token increasing the expiration date by 30 days.

HEADERS

token

Example Request

curl

curl --location 'https://quickconsolsqa.com/api/user/refreshToken' \
--header 'token: xxxxxxxx'

200 OK

Example Response

json

{
  "success": false,
  "message": null,
  "code": "0000",
  "obj": "xxxxxxx"
}

Cache-Control

no-cache

Pragma

no-cache

Content-Type

application/json; charset=utf-8

Expires

-1

Server

Microsoft-IIS/10.0

X-AspNet-Version

4.0.30319

X-Powered-By

ASP.NET

Access-Control-Allow-Origin

Access-Control-Allow-Headers

Content-Type

Access-Control-Allow-Methods

GET, POST, PUT, DELETE, OPTIONS

Date

Tue, 22 Aug 2023 14:52:18 GMT

Content-Length