API Reference

Get authentication token that allows customer to log in or verified in other applications.

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

This endpoint returns an authentication token. Another application that uses the CareCloud API can use this token to verify the customer or sign the customer in. Typical uses include redirecting a logged-in customer from one app to another, or completing sign-in in an in-app browser for a different application or portal.
⚠️ Endpoint is available only in Customer interface.

Path Params
string
required

A client application token.

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

integer
enum
required
Defaults to 1

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

Allowed:
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 5 months ago

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