Skip to content

API

Dexter provides a REST API for external tools and integrations. The API must be enabled by setting an API secret in the configuration.

Enabling the API

{
  "server": {
    "apiSecret": "your-secret-key"
  }
}

Warning

If apiSecret is empty, the API is disabled. Choose a strong, random secret.

Authentication

All API requests must include the secret as a query parameter or header:

GET http://localhost:3030/api/config/poracleWeb?secret=your-secret-key

Endpoints

Section Description
Configuration Read server configuration
Geofence Generate geofence maps and distance maps
Humans Manage user profiles, locations, and tracking