API Reference

Login via authentication token

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/tokens//actions/authentication-token-login

Log in the customer using the provided authentication token for a seamless and secure login experience.
The authentication token can be provided in the method GET /tokens/{token_id}/actions/auth-token
⚠️ Endpoint is available only in Customer interface.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

A client application token.

Body Params
string
required

ID of the destination external application.
Please provide the destination external application ID, not the token-issuing external application ID.
Need a destination external application ID? Please contact your CareCloud administrator.

string
required

Authentication token

string
required

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 doubled verification to identify the correct token. In case you dont need to have two factor authentication, please send both parameters (token and token_request_id) one way. For example in HTTP Authentication header.

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

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

Responses

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 about 1 month ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago