Authentication Request

Purpose

This method authenticates the end user with the system. By default, the Interaction Runtime Server provides 2 types of authentication methods:

•Cache based authentication: Uses a cache to store authentication details. The cache is size limited, and prolongs token validity as long as it is being accessed by the client.

•Basic authentication: Uses mapping to store authentication details. The token can be defined with or without an expiration time, and is not prolonged due to client access.

For details about how to define your own authentication implementation for the Jacada Interaction Server client, refer to the Jacada Interaction Server Installation Guide.

Note: A token is used in any consequent request from a Jacada Interaction Server client to the server (see HTTP/S Request Header).

This request may be replaced according to the developer requirements and constraints. In some cases, the Interaction Server client can skip this phase according to a predefined configuration, and work without authentication.
URI Syntax and Example

http://[host:port]Application Name/version/[version]/account/[accountID]/[object]

http://api.Interact.jacada.com/version/1/account/12345678/auth/

HTTP Method

POST

tog_minusBody Request Parameters

The Authentication Request body example parameters are as follows:

Field Name

Data Type

Description

user

String—Base64 encoded

User name enabled to work with the system. Usually this field is based on the end-user email address, which is used in the registration process.

password

String—Base64 encoded

According to the following format:

String pass = "abcd";

String randomString = "fdflkhfdlfhla"; // randomized string with fixed length

String password =  randomString + pass;

password = Base64.encode(pass);
Body Request Example

An Authentication Request body example is as follows:

{

      "user":"2097LSLW01387DKLK2038127"

      "password":"D;LH;LH23O81Y832Y8767362&&32973IEHJKDS"

}
Response

HTTP OK 200

Response Example

An Authentication Request response example is as follows:

{

      "Security-Token":"2097LSLW01387DKLK2038127"

}