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.
API | Purpose | Role Required |
---|---|---|
GET /v1/firmware | Get all firmware details | firmware |
POST /v1/firmware | Add new firmware details | firmware |
GET /v1/devices/{deviceid} | Get device details | deviceadmin |
GET /v1/devices/{deviceid}/logs | Get a map of device's logtypes and counts. See Device Log files | deviceadmin |
GET /v1/devices/{deviceid}/logs/{logtype} | Get a list of device's logs by type. See Device Log files | deviceadmin |
GET /v1/devices/{deviceid}/logs/{logtype}/{name} | Get the content of a specific log file. See Device Log files | deviceadmin |
PUT /v1/support/{lang} | Update support content for a language | support |
DELETE /v1/support/{lang} | Delete support content for a language | support |
GET /v1/users?email={email} | Get user and device support details by email address | useradmin |
DELETE /v1/users?email={email} | Remove all user-device associations and user data from the platform | useradmin |
GET /v1/users/{userid}/devices | Get devices support details associated with a userid | useradmin |
PUT /v1/users/{userid}/abilities | Set user's abilities. See Admin Site. | useradmin |
DELETE /v1/users/{userid}/devices/{deviceid}/owner | Remove a user's ownership of a device | useradmin |
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.
API | Purpose | Role Required |
---|---|---|
GET /v1/customconfig | Get all custom configuration that clients can access | support |
GET /v1/customconfig/{countrycode} | Get custom configuration that clients can access for a specific country | support |
PUT /v1/customconfig/{countrycode} | Update custom configuration that clients can access for a specific country | support |
Finally, you may wish to create an administration or support website - please see creating an admin site for more information.