API Reference

Create a token

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/tokens

Create an authentication token for a client application installation.

⚠️ Endpoint is available only in the Customer interface.

⚠️ When creating a new token, the request does not need to contain an Authentication header.

⚠️ We highly recommend filling all identifications in the tokens resource (device and application) to avoid problems if multiple applications use the CareCloud REST API on one device.

What happens when a token is created

  • A token record is created and its server-generated token_id is returned.
  • The token is bound to the supplied device identification and setup parameters (language, GPS permission, notifications permission).
  • The token is used as the credential on subsequent customer-interface requests, sent as Authorization: Bearer <token_id>. See Authentication for the full flow.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
device
object
required

Structure describes the client device or browser.

setup
object
required

Setup of a client's device.

string
required

ID of the external application. More information about external applications and how to get an ID is available in Authentication section

string

Push notification token (Apple or Google).

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

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

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

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 days ago

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

Updated 5 days ago