Panel | ||
---|---|---|
| ||
|
...
JSON Web Tokens in CRM.COM should have a length more than 32 characters and they consist of three parts separated by dots (.
), which are
- Header
- typ: The type of the token, which is JWT
- alg: The hashing algorithm being is used, which is HS256
- Payload: contains the claims which are statements about an the user and additional metadata
- jti: The ID of the user session as generated by CRM.COM
- usr: The username of the logged in user
- org: The organisation organization name of the organisation organization that the user logged in
- oun: The unit name of the unit that the user logged in
- exp: The expiration time on or after which the JWT becomes invalid and should not be accepted for processing
- iat: The time at which the JWT was issued
- cii: The contact information identifier (applicable only when authenticating consumer-based applications)
acr: The accounts receivable identifier (applicable only when authenticating consumer-based applications)
- Signature: is used to verify that the sender of the JWT is who it says it is and to ensure that the message wasn't changed along the way. The signature is created by encoding the header and payload and signing them using a secret and the HS256 algorithm
...
Note that the JWT values are case sensitive. Also the , exp and iat claims are defined in as numeric dates. A numeric date is a JSON numeric value representing the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds. There are online tools that you can use to check and validate the JWT, such as the JWT Debugger and also to calculate and validate numeric dates, such as the Epoch Converter
...
This is the recommended method of authentication using Web API Keys of a "Systemic Key" classification. Web API Keys are assigned to specific users in order to access a specific organisation organization and can be used to authenticate users through Web API, resulting to an authentication token that can subsequently be used by other Web API calls
...
This is an alternative method of authentication using Web API Keys of a "Consumer Application Key" classification. Web API Keys are assigned to specific users in order to access a specific organisation organization and can be used to authenticate users through Web API, resulting to an authentication token that can subsequently be used by other Web API calls
...