Authentication Interface

Scenario

This interface is invoked by the CTI-OBS to access the CC-iSales using a username and password.

Method

Post

URI

https://Domain name/rest/isales/v1/openapi/obs/auth/login. An example of the domain name is service.besclouds.com.

Request Description

Response Description

• Response status code: 200

  Table 3 Response body parameters

  No.	Parameter	Value Type	Description
  1	result	String	Error code. The options are as follows: 0: success Other values: failure
  2	resultData	Object	Object in the returned result after a successful query.

  Table 4 resultData object

  No.	Parameter	Value Type	Description
  1	token	String	Authentication token.
  2	tokenExpirationTime	String	Validity period of the authentication token.
  3	refreshToken	String	Refreshes the token.
  4	refreshExpirationTime	String	Refreshes the token validity period.

Error Codes

• Response status code: 400

  Incorrect request. Check the request path and parameters.

• Response status code: 401

  Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

• Response status code: 403

  Authentication failed.

• Response status code: 404

  The requested content is not found. Check the request path.

• Response status code: 500

  Business failure. Check the values of parameters in the request.

Example

• Request header:

Content-Type:application/json

• Request message:

{
"user":"abcd",
"passwd":"123456"
}

• Response message:

  {
  "result":0,   // 0: success; other values: failure
      "resultData": {
          "token":"fajiofjqwioeha",
          "tokenExpirationTime":300,// Unit: second
          "refreshToken":"fajiofjqwioeha",
          "refreshExpirationTime":3600,// Unit: second
  }
  }