POST authentication/web_api_key/token

Available from CRM.COM R10.0.0

This method returns an authentication token which can subsequently be used by all other Web API method to access the system. Note that the authentication token expires after two hours.

Token expires after two hours, regardless of if the token is used or not, and a new one should be retrieved

From CRM.COM R12.0.0 onwards: The token is returned in JWT structure and the length of the token will be more that 32 characters

Resource URL

Parameters

Name

Type

Description

key

String

The key should be passed via HTTP Basic Auth, as the basic auth username. The basic auth password should be left empty

unit

(optional)

String

The unit ID that the user will use during login. If not specified then the default unit for that user is used

Response Data

Name	Type	Description
token	String	The authentication token which can be used to access CRM.COM. The token expires after two hours

Examples

Example 1

HTTP Method: POST

Request:

Headers:

Key	Value	Comments
Content-Type	application/json
Authorization	Basic RUU3M0MwQUU2NDUyNDM3MUI1RERFRkY1RjdCQjIxOTI6	Note that the Web API key for this example is EE73C0AE64524371B5DDEFF5F7BB2192, which is encrypted and set as the authorisation parameter based on the HTTP Basic Auth protocol

Post Data:

{
 	"unit": "EE63A82C4FEBE02FF34E90DD1EBA5ABE"
}

Response:

 {
  "data": {
    "token": "1351195444"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}