Authentication

Field	Details
API Name	Authenticate
URL Format	<protocol>://<domain-name>/<VirtualDir>/<URL>
Example URL	https://localhost:8080/OTPA/V1/Authenticate
Description	Use this API to obtain the authorization token required for all further API calls.
Required Inputs	- API Key - Secret Key
Token Validity	Token is valid only for the current day and expires at 11:59:59 PM. A new token must be generated daily.
Usage Note	All subsequent API requests must include the latest token in the Authorization header.

🗝️ Authentication Request Parameters

The following parameters are required in the JSON request body.
These are referred to as Request Info throughout the document.

Parameter	Data Type	Description
jAPIKey	varchar(255)	API key provided by SynapseWave Innovations Private Limited
jSecretKey	varchar(255)	Secret key provided by SynapseWave Innovations Private Limited
jRequestID	varchar(255)	Echo‑back field returned unchanged in the response

Example Request

{
  "jAPIKey": "<API Key>",
  "jSecretKey": "<Secret Key>",
  "jRequestID": "<Echo back field>"
}

---

📝 Authentication Response Parameters

The ResponseObject contains the following parameters in the JSON response.

Parameter	Data Type	Description
jRequestID	varchar(255)	Echo‑back field returned unchanged from the request
jResponseID	varchar(255)	System‑generated alphanumeric ID
jStatuscode	int	1 = Success, -1 = Failure
jErrorString	varchar(255)	Free‑flowing error message (only present when failure occurs)
jToken	varchar(512)	Unique authorization token to be used in subsequent requests (valid until 11:59 PM of the same day)

Example Response

{
  "jRequestID": "<Echo back field>",
  "jResponseID": "<System generated alpha numeric id>",
  "jStatuscode": 1,
  "jErrorString": "<Free Flowing Error Message>",
  "jToken": "<Authorization Token - valid till 11:59 PM>"
}