Table of Contents

maxLevel	2

POST authentication/token

This method returns an authentication token which can subsequently be used by all other Web API method to access the system.

Note

Token expires after one hour of idle time (i.e. one hour of not using the token)

From CRM.COM R12.0.0 onwards: Token expires after two hours, regardless of if the token is used or not, and a new one should be retrieved. 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
username (mandatory)	String	The username that should be used to login.
password (mandatory)	String	The password that should be used to login.
organisation (mandatory)	String	The organization on which the user will login
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 login

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Post Data:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "username": "mpadministrator",
    "password": "1234",
    "organisation": "CRMDEMO",
    "unit": "EE63A82C4FEBE02FF34E90DD1EBA5ABE"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status": {
        "code": "OK",
        "message": null,
        "description": null
    },
    "data": {
        "token": "4AD9C84FA60F9FE407140E20F707726A"
    }
}

POST authentication/web_api_key/token

Tip
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.

Note

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

Expand

title	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:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
 	"unit": "EE63A82C4FEBE02FF34E90DD1EBA5ABE"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

POST authentication/token/release

Tip
Available from CRM.COM R10.0.0 and deprecated from CRM.COM R12.0.0 onwards

This method releases an authentication token in order to make it not usable by any other subsequent Web API calls

Note
Token expires every one (1) hour and a new one will need to be retrieved. It is recommended to release tokens if there are not needed any more

Resource URL

Parameters

Name

Type

Description

token

(mandatory)

String

The authentication token which will be released

Response Data

Not applicable

Examples

HTTP Method: POST

Request:

Post Data:

Expand

title	Example 1

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "token":"{{token}}"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{ "status": { "message": "", "description": "", "code": "OK" }, "data": {} } Panel

name	blue

Child pages (Children Display)

excerpt	true

Versions Compared

Old Version 29

New Version 30

Key

POST authentication/token

Resource URL

Parameters

Response Data

Examples

POST authentication/web_api_key/token

Resource URL

Parameters

Response Data

Examples

POST authentication/token/release

Resource URL

Parameters

Response Data

Examples

Page Comparison

Versions Compared

Old Version 29

New Version 30

Key

POST authentication/token

Resource URL

Parameters

Response Data

Examples

POST authentication/web_api_key/token

Resource URL

Parameters

Response Data

Examples

POST authentication/token/release

Resource URL

Parameters

Response Data

Examples