Skip to content

HeyDonto Authentication Documentation (1.0)

API documentation for HeyDonto Authentication and User Management

Powered by HeyDonto
Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/authentication/openapi/

Sandbox

https://api-staging.heydonto.com/

Production

https://api.heydonto.com/

Users

Operations

Authentication

Operations

Synchronizer Authentication

Operations

Activate synchronizer with site license key

Request

Exchange site license key for synchronizer-specific access tokens

Bodyapplication/jsonrequired
licenseKeystringrequired

Site license key

Example: "SITE-LICENSE-KEY-123"
deviceIdstringrequired

Unique device identifier

Example: "DEVICE-ABC-123"
versionstringrequired

Synchronizer software version

Example: "1.0.0"
hostnamestring

Machine hostname

Example: "dental-office-server"
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/authentication/openapi/auth/synchronizer/activate \
  -H 'Content-Type: application/json' \
  -d '{
    "licenseKey": "SITE-LICENSE-KEY-123",
    "deviceId": "DEVICE-ABC-123",
    "version": "1.0.0",
    "hostname": "dental-office-server"
  }'

Responses

Successfully activated and returned tokens

Refresh synchronizer tokens

Request

Exchange refresh token for new access tokens

Bodyapplication/jsonrequired
refreshTokenstringrequired

Refresh token from previous activation

deviceIdstringrequired

Device identifier

Example: "DEVICE-ABC-123"
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/authentication/openapi/auth/synchronizer/refresh \
  -H 'Content-Type: application/json' \
  -d '{
    "refreshToken": "string",
    "deviceId": "DEVICE-ABC-123"
  }'

Responses

Successfully refreshed tokens

Deactivate synchronizer

Request

Revoke all tokens and unregister synchronizer device

Bodyapplication/jsonrequired
licenseKeystringrequired

Site license key

Example: "SITE-LICENSE-KEY-123"
deviceIdstringrequired

Device identifier

Example: "DEVICE-ABC-123"
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/authentication/openapi/auth/synchronizer/deactivate \
  -H 'Content-Type: application/json' \
  -d '{
    "licenseKey": "SITE-LICENSE-KEY-123",
    "deviceId": "DEVICE-ABC-123"
  }'

Responses

Successfully deactivated synchronizer

Send synchronizer heartbeat

Request

Report synchronizer health and metrics

Security
bearer
Bodyapplication/jsonrequired
deviceIdstringrequired

Device identifier

Example: "DEVICE-ABC-123"
siteIdnumberrequired

Site ID

Example: 1
statusstringrequired

Synchronizer status

Enum"healthy""degraded""error"
lastSyncTimestring(date-time)

Last successful sync time

errorCountnumber

Number of errors in current session

metricsobject

Additional metrics

curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/authentication/openapi/auth/synchronizer/heartbeat \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "deviceId": "DEVICE-ABC-123",
    "siteId": 1,
    "status": "healthy",
    "lastSyncTime": "2019-08-24T14:15:22Z",
    "errorCount": 0,
    "metrics": {}
  }'

Responses

Heartbeat acknowledged