• API Endpoints

  List of endpoints available through our API. For information on how to use the API please see this article. Device Endpoint Device Group Endpoint Profile Endpoint File Group Endpoint (hFew readers

• How to use the REST API

  The Kiosk Browser Remote API is available for all subscribers. It is designed to allow programmatic access to devices and other relevant information within your account. A list of all available endpoints can be found here. Security The API implements HMAC authentication which uses an API Key and Secret Key (secret key is only known to ourFew readers

• Example: C# .NET Device API

  Sample code to consume the Device API using C.Few readers

• API Endpoint: Device

  GET /api/device - get all devices on account /api/device/1 - get device with id of 1 /api/device?identifier=b60e7c95-d160-439d-8dc6-4c7e1648bd1a - get device on account using device identifier DELETE /api/device/1 - delete/unpair device with id of 1 PATCH /api/device/1 - patch (update) device with id of 1 When using PATCH only the supplied values are updated. If for example you supply no value for the device name, it will not change within remote management. InFew readers

• Example: PHP Device API

  Sample code to consume the Device API using PHP.Few readers

• API Endpoint: Push

  The push endpoint allows you to push actions to devices or groups of devices as listed below: GET /api/push/1/pushtype - send push request to device ID 1 with push type from list below /api/pushgroup/1/pushtype - send push request to all devices in devicegroup ID 1 with push type from list below: Valid Push Types Request Status from Device (heartbeat to server, battery, screen state etc...) Update device info (information such as software version, Android version etFew readers

• Example: Node.js Device API

  Sample code to consume the Device API using Node.js.Few readers

• API Endpoint: Profile

  A Profile stores all Kiosk Browser related settings within Remote Management. GET /api/profile - get all profiles on account /api/profile/1 - get profile with id of 1 PATCH /api/profile/1 - patch (update) profile with id of 1 When using PATCH only the supplied values are updated. If for example you supply no value for the device name, it will not change within remote management. Include json in the request body as per examples below: Properties: kioskurl (string), filegrouFew readers

• API Endpoint: Device Group

  A Device Group is used to group together devices and has a profile assigned to it. GET /api/devicegroup - get all device groups on account /api/devicegroup/1 - get devicegroup with id of 1 POST /api/devicegroup - create device group, include json in the request body as per below: If "createregistrationkey" is setFew readers

• API Endpoint: Registration Key

  A Registration Key is used to register devices to Remote Management. GET /api/registrationkey - get all registration keys on account /api/registrationkey?key=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx - get registration key by key POST /api/registrationkey - create registration key, include json in the request body as per below:Few readers

• API Endpoint: File Group File

  A File Group File is stored within a File Group. GET /api/filegroupfile/1 - get all files stored within filegroupid 1 DELETE /api/filegroupfile/1 - delete file within filegroupid 1, include json in the request body as per examples below: Properties: path (string)Few readers

• API Endpoint: File Group

  A File Group is a container for storing files you wish to deploy to devices via Remote Management. GET /api/filegroup - get all file groups on account /api/filegroup/1 - get filegroup with id of 1 POST /api/filegroup - create file group, include json in the request body as per below: PATCH /api/filegroup/1 - patch (update) filegroup with id of 1 When using PATCH only the supplied values are updated. If for example you supFew readers

• Example: Python Device API

  Sample code to consume the Device API using Python.Few readers