Admin APIs

The Audiogum platform provides administration APIs to allow partners to query various items for support purposes.

The admin APIs are authenticated with basic authentication, locked down to specific users. Get in contact with us to obtain your credentials.

APIPurposeRole Required
GET /v1/firmwareGet all firmware detailsfirmware
POST /v1/firmwareAdd new firmware detailsfirmware
GET /v1/devices/{deviceid}Get device detailsdeviceadmin
GET /v1/devices/{deviceid}/logsGet a map of device's logtypes and counts. See Device Log filesdeviceadmin
GET /v1/devices/{deviceid}/logs/{logtype}Get a list of device's logs by type. See Device Log filesdeviceadmin
GET /v1/devices/{deviceid}/logs/{logtype}/{name}Get the content of a specific log file. See Device Log filesdeviceadmin
PUT /v1/support/{lang}Update support content for a languagesupport
DELETE /v1/support/{lang}Delete support content for a languagesupport
GET /v1/users?email={email}Get user and device support details by email addressuseradmin
DELETE /v1/users?email={email}Remove all user-device associations and user data from the platformuseradmin
GET /v1/users/{userid}/devicesGet devices support details associated with a useriduseradmin
PUT /v1/users/{userid}/abilitiesSet user's abilities. See Admin Site.useradmin
DELETE /v1/users/{userid}/devices/{deviceid}/ownerRemove a user's ownership of a deviceuseradmin

The following APIs allow custom configuration per country to be obtained to your client apps and firmware. The configuration allows any key/value pairs for complete flexibility.

The custom configuration, once set up using these admin APIs, is retuned to the device client as part of the response for GET /v1/config.

APIPurposeRole Required
GET /v1/customconfigGet all custom configuration that clients can accesssupport
GET /v1/customconfig/{countrycode}Get custom configuration that clients can access for a specific countrysupport
PUT /v1/customconfig/{countrycode}Update custom configuration that clients can access for a specific countrysupport

Finally, you may wish to create an administration or support website - please see creating an admin site for more information.