X-API Keys
PlaceOS can generate API Keys for authenticated access.
The API keys can be used for:
Accessing the PlaceOS API
Using the Real-time Websocket
Prerequisites
Administrator access to your PlaceOS Backoffice
Generate API Key
Login to PlaceOS Backoffice
Navigate to the Admin Tab
Select the domain the API Key will belong to
Any existing API Keys will be shown in the list
Enter the required information:
Name: Suitable name for the API Key
Description: What the key will be used for (useful for other administrators)
Scopes: Select from available scopes (see available scopes below)
User: The user in which the API Key will emulate
Click Save
Available Scopes
Available Scopes for API Keys are:
public
A special scope that can access all routes (supports read and write modifiers)api_keys
ldap_authentication
saml_authentication
o_auth_authentication
o_auth_applications
brokers
cluster
domains
drivers
settings
modules
guests
A special scope for guests that provides access to some APIssystems
control .read
: module class types, function list of a module, module state lookup.write
: control websocket, API execute requestedges
metadata
repositories
Available Permissions
scope.read
scope.write
Using the API Key
API Keys are typically passed in the header of the request, however can be used in the following ways
HTTP Header:
X-API-Key: <token>
URL param:
?api-key=<token>
A HTTP Cookie:
api-key=<token>
Removing an API Key
Navigate to the API Key Page in Backoffice located in the Admin Tab.
Scopes for Common Applications
X-API Keys can be used for unattended panel authentication, scopes are required for these applications to function. The table below outlines common applications that require API Keys and the associated scopes.
Application | Scopes |
---|---|
Booking Panel |
|
Map Kiosk |
|
Last updated