Request a token

POST

/api/token/create

This is the first step in the process - only once you have been issued with a token, will you be able to initiate the request...
The token is valid for 60 minutes after an initial API requests - an unexpired token can be refreshed within the next 12 hours. or a new token can be requested.

Request

Body Params application/json

subscriber_id

string

required

Code to identify a subscriber

Example:

DEMO01

Example

{
    "subscriber_id": "TEST0001"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://qid.aiq.bio/api/token/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subscriber_id": "TEST0001"
}'

Responses

🟢200OK

application/json

Body

status

boolean

required

Indicates whether the reuqest is succesfully received or not

token

string

optional

Token to be used to perform the other API requests

Example:

pqwiurbcxz3278bhfdjngdsomznaxb2143lakn

code

string

required

Response code. For example, 055 indicates a successful token

message

string

required

The description for the response.

Examples

FailureSuccess

{
    "status": false,
    "code": "001",
    "message": "No Subscriber ID provided"
}

Modified at 2024-08-05 11:57:13

API

Refresh an existing token