Passing Authentication

The Opentact API will require an API Key to authenticate requests.

All API requests are required to be made over HTTPS, HTTP requests will return back a 302 response - permanent redirection.

There are 5 methods to pass authentication to the API.

Basic

For accessing the API a valid email and password must be passed in the 'Authorization' header.

The following syntax must be used in the header

'Authorization: Basic base64(email:password)

A valid token is base64 encoded value of 'email:password'

  The following syntax must be used in the headers:
      Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=v

Security Scheme Type	HTTP Authorization Scheme
HTTPS	Basic

JWT

Google

Facebook

HA1B

Username and password must be required for the Basic Auth

This field is used to enter the jwt token to authorize the opentact API.

Authentication API

GET https://api.opentact.org/rest/auth

This api is to get the JWT token for Authorize.

Headers

Name	Type	Description
X-Auth token*	String	JWT token

200: OK User Logged In

{
  "success": true,
  "payload": {
    "uuid": "0116f6d1-1280-44b2-9134-da48509ec575",
    "email": "[email protected]",
    "wss_online": true,
    "role": "User",
    "created_on": "2022-12-29T13:17:57.457Z",
    "modified_on": "2022-12-29T13:17:57.457Z",
    "deleted_on": null,
    "phone_number": "[phone]",
    "dob": "2022-12-29T13:17:57.457Z",
    "avatar": "https://google/image.png",
    "first_name": "First Name",
    "last_name": "Last Name",
    "gender": "Female",
    "account": {
      "created_on": "2022-12-29T13:17:57.457Z",
      "modified_on": "2022-12-29T13:17:57.457Z",
      "uuid": "f2cb79fb-6bf8-4484-8034-debf95aac73b",
      "email": "[email protected]",
      "name": "DENOVOLAB",
      "level": "Level0",
      "deleted_on": null,
      "balance": 99.87895
    }
  }
}

401: Unauthorized Unauthorized

500: Internal Server Error Internal server error