Versions Compared

Old Version 27

changes.mady.by.user George Rossides

Saved on

compared with

New Version 28

changes.mady.by.user George Rossides

Saved on

Key

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

Table of Contents
maxLevel2

...

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

 

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

...

Name

Type

Description

token

String

The authentication token which can be used to login

Tip

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

Examples

Expand
titleExample 1

HTTP Method: POST

 Request:

 

Post Data:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "username": "mpadministrator",
    "password": "1234",
    "organisation": "CRMDEMO",
    "unit": "EE63A82C4FEBE02FF34E90DD1EBA5ABE"
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
{
    "status": {
        "code": "OK",
        "message": null,
        "description": null
    },
    "data": {
        "token": "4AD9C84FA60F9FE407140E20F707726A"
    }
}

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

...

Parameters

Name

Type

Description

token

(mandatory)

String

The authentication token which will be released

...

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. 

...

Name

Type

Description

keyStringThe 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

...

Name

Type

Description

token

String

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

Tip

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

Examples

Expand
titleExample 1

HTTP Method: POST

 Request:

Headers:

KeyValueComments
Content-Typeapplication/json 
AuthorizationBasic RUU3M0MwQUU2NDUyNDM3MUI1RERFRkY1RjdCQjIxOTI6Note 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
themeConfluence
languagejavascript
linenumberstrue
{
 	"unit": "EE63A82C4FEBE02FF34E90DD1EBA5ABE"
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
  "data": {
    "token": "1351195444"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}