Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Message direction

Format

Body

Additional info (possible values)

Request

JSON

{

  • "device":"string",
  • "version":"string",
  • "login":"string",
  • "password":"string",
  • "companyId": "int"

}

email from registration is used as login

As example:

{
"device":"iOS",
"version":"3.00",
"login":"techsupport",
"password":"jxsmoBhz"
}

Response

JSON

{

}

 

ResponseCode values: 0, 1, 2, 3

Ticket is authentication ticket.

AuthStep:

  • 0-OK,
  • 1-EnterPin (need to provide PIN invoking EnterPIN method),
  • 2-EnterSecuritySettings (need to set PIN for user invoking SetSecuritySettings method)
  • 3-Agreement (need to accept agreements for user)
  • 4-PasswordExpired (need to enter new password for user because old password expired)

 


Recover Session

Refresh expired ticket and session.

...

Message direction

Format

Body

Additional info (possible values)

Request

JSON

 

{

  • "ticket":"string",
  • "pin":"string",

}

 

Response

JSON

{

}

 

Enter New Password

Send user's new password for sign in to the system in the case when old user's password expired

Url: {server-path}/enter-new-password

HTTP Method: POST

Message direction

Format

Body

Additional info (possible values)

Request

JSON

 

{

  • "ticket":"string",
  • "password":"string",

}

 

 

Response

JSON

{

}

 

Set SecuritySettings

Url: {server-path}/set-security-settings

...