API Reference
Start typing to search…

Get authentication token

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/tokens//actions/auth-token

Returns authentication token for specific external application.
⚠️ Endpoint is available only in Customer interface.

Log in to see full request history
Path Params
string
required

A client application token.

Query Params
string
required

ID of an external application. This is an application that you want to login a customer with an authentication token. For ID of an external application, please contact your CareCloud administrator.

integer
required
Defaults to 1

Parameter set witch token type should be generated. Possible values: 1- alphanumeric, 2- numeric

Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body
object
data
object
string

Authentication token allows customer to log in into another external application.

string

The parameter specifies the request that caused the token to be created. If two customers generated an authentication token at the same time and in the same application, the token_request_id parameter represents additional verification to identify the correct token.

string

Date and time of the token validity. (YYYY-MM-DD HH:MM:SS)

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated over 1 year ago

Did this page help you?
Language
Credentials
URL

Updated over 1 year ago

Did this page help you?