{"info":{"_postman_id":"7d338fd5-8908-4287-978d-378d5542b681","name":"Kiosker API V.1","description":"

The Kiosker API offers a RESTful interface for seamless interaction with the Kiosker app, employing JSON for both request and response bodies to ensure efficient and standardized data exchange.

Security

We strongly recommend that the API is accessed via HTTPS. Enable TLS by generating a self-signed TLS certificate and importing it into Kiosker. Please refer to the documentation for more information.

Authentication

Authentication is conducted via a static bearer token. The token is device-specific and generated in the Kiosker App. Pass the token in the Authorization header, eg. \"Authorization: Bearer ABC123\". Replace ABC123 with your token.

Changelog

V1.1

Added get screensaver state by [GET] screensaver/state.
\n
BREAKING: Renamed blackOut object to blackout. This is a typo fix.
\n

Further information

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"30955748","collectionId":"7d338fd5-8908-4287-978d-378d5542b681","publishedId":"2sAYdiopcn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-03-03T22:27:09.000Z"},"item":[{"name":"API Status","event":[{"listen":"test","script":{"id":"14ec8cb8-9e43-4e74-a416-06e3da82dff9","exec":["var template = `","","",""," "," "," "," "," "," "," "," "," "," ","

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Retrieve Status

This endpoint allows you to retrieve the current status, including battery level, last motion, device ID, last interaction, model, date, battery state, and OS version.

Response

Upon a successful request, the server will respond with a JSON object containing the status information. The response will include the following fields:

error (boolean): Indicates if an error occurred.
\n
function (string): Always \"status\" for this request
\n
status (object): Contains the status details, including:
\n
- batteryLevel (integer): The current battery level as integer in range 0-100.
  \n
- lastMotion (string): Timestamp of the last motion detected. A screensaver with motion detection enabled must be active.
  \n
- deviceId (string): The unique identifier of the device.
  \n
- lastInteraction (string): Timestamp of the last user interaction.
  \n
- model (string): The model of the device.
  \n
- date (string): Date of the status report.
  \n
- batteryState (string): The state of the battery.
  \n
- osVersion (string): The operating system version of the device.
  \n
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7d338fd5-8908-4287-978d-378d5542b681","id":"7d338fd5-8908-4287-978d-378d5542b681","name":"Kiosker API V.1","type":"collection"}},"urlObject":{"protocol":"http","port":"8081","path":["api","v1","status"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b20d0375-149c-437b-8708-9030d3e24d44","name":"Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://:8081/api/v1/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"287"},{"key":"connection","value":"keep-alive"},{"key":"date","value":"Mon, 03 Mar 2025 20:25:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"function\": \"status\",\n \"status\": {\n \"batteryLevel\": 100,\n \"lastMotion\": \"2025-03-03T19:57:08Z\",\n \"deviceId\": \"E1D09309-F004-40E2-BADE-A9EC00FA112B\",\n \"lastInteraction\": \"2025-03-03T19:57:18Z\",\n \"model\": \"iPad\",\n \"date\": \"2025-03-03T20:25:33Z\",\n \"batteryState\": \"Fully Charged\",\n \"osVersion\": \"18.3\"\n }\n}"},{"id":"13795367-bb0f-4419-bfac-f1cd471dbe00","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://:8081/api/v1/status"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"38"},{"key":"connection","value":"keep-alive"},{"key":"date","value":"Mon, 03 Mar 2025 20:27:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": true,\n \"reason\": \"Unauthorized\"\n}"},{"id":"5fb3b517-b09f-47a9-8c7f-62211592ec94","name":"API Status","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://:8081/api/v1/status"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"315"},{"key":"connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": false,\n \"function\": \"status\",\n \"status\": {\n \"batteryLevel\": 95,\n \"batteryState\": \"Not Charging\",\n \"model\": \"SM-X816B\",\n \"osVersion\": \"Android 16\",\n \"appName\": \"Kiosker\",\n \"appVersion\": \"25.0.0\",\n \"lastInteraction\": \"2026-03-14T14:55:02.343052Z\",\n \"deviceId\": \"531D5BCB-1E20-468D-8AD4-7EE489DA5ABB\",\n \"date\": \"2026-03-14T14:55:06.313458Z\"\n }\n}"}],"_postman_id":"0b435d5c-37dd-47f6-aca8-be7e70daeec9"},{"name":"API Ping","event":[{"listen":"test","script":{"id":"14ec8cb8-9e43-4e74-a416-06e3da82dff9","exec":["var template = `","","",""," "," "," "," "," "," "," "," "," "," ","

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

","`;","","function constructVisualizerPayload() {"," return { response: pm.response.json() }","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"10534e87-7a22-47f8-9307-ed017aab86c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"enableLog\": true,\n \"screensaverSchedule\": [],\n \"idleTimeoutSeconds\": 120,\n \"audioVideoPermission\": 1,\n \"screenMenuPrint\": true,\n \"useiCloud\": false,\n \"allowBiometrics\": true,\n \"disableTouch\": false,\n \"noCache\": false,\n \"autoDeleteCookies\": false,\n \"customUserAgentString\": \"\",\n \"skipAutoReloadTimeoutSeconds\": 120,\n \"autoReloadSeconds\": 43200,\n \"metaTime\": null,\n \"disableZoom\": false,\n \"skipAutoReloadWhenInUse\": false,\n \"apiIpWhitelist\": [],\n \"screenMenuHide\": true,\n \"disableContactLinks\": false,\n \"screenMenuSettings\": true,\n \"disableDoubleTap\": false,\n \"restrictDomain\": 0,\n \"screenMenuNavigation\": true,\n \"browserLimitSeconds\": 300,\n \"printPaperCustomSize\": null,\n \"url\": \"https://svt.se\",\n \"timeOutMessage\": \"Browsing time limit exceeded\",\n \"popupInNewWindow\": 100,\n \"passwordProtect\": true,\n \"screenMenuFavorite\": true,\n \"idleMotionDetection\": 0,\n \"disableScreenSleep\": true,\n \"apiEnableCameraSensor\": false,\n \"flicMode\": 0,\n \"disableCustomLinks\": false,\n \"flicActive\": false,\n \"browserLimit\": false,\n \"idleTimeoutMessageSeconds\": 30,\n \"disableScroll\": false,\n \"apiActive\": true,\n \"allowedDomains\": [],\n \"idleTimeoutMessage\": \"Are you still there?\",\n \"skipAutoReloadMotionDetection\": 0,\n \"disableSelect\": false,\n \"allowInsecureSSL\": false,\n \"printOrientation\": 0,\n \"injections\": [],\n \"flicUrl\": null,\n \"orientation\": 0,\n \"autoSingleAppMode\": false,\n \"autoReload\": 0,\n \"disablePullToRefresh\": false,\n \"silentPrint\": false,\n \"showIdleTimeoutMessage\": true,\n \"apiTLS\": false,\n \"hideNavBarOnHome\": false,\n \"localWebserver\": false,\n \"shareCookies\": false,\n \"apiIpFilter\": false,\n \"disableEditMenu\": false,\n \"showTimeOutMessage\": true,\n \"autoReloadError\": true,\n \"autoFill\": [],\n \"ignorePopupForCustomScheme\": true,\n \"printPaperSize\": \"Legal\",\n \"disableScrollBounce\": false,\n \"showStatusBar\": false,\n \"disableSwipeToNavigate\": false,\n \"deniedDomains\": [],\n \"enableJSLog\": true,\n \"disableHistory\": true,\n \"showSettingsOnStart\": false,\n \"screenMenuHome\": true,\n \"showLoader\": true,\n \"javaScriptIntegration\": false,\n \"favorites\": [],\n \"userAgentMode\": 0,\n \"navBar\": false,\n \"idleTimeout\": false,\n \"statusbarMode\": 0,\n \"password\": {\n \"len\": 4,\n \"hash\": \"$argon2i$v=19$m=16,t=2,p=1$emtSQ05RZ0FGNFFPUlJXZg$0M0aXlIhU2VaLp7MLOTAEQ\"\n },\n \"pageZoom\": 1\n }","options":{"raw":{"language":"json"}}},"url":"http://:8081/api/v1/settings","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7d338fd5-8908-4287-978d-378d5542b681","id":"7d338fd5-8908-4287-978d-378d5542b681","name":"Kiosker API V.1","type":"collection"}},"urlObject":{"protocol":"http","port":"8081","path":["api","v1","settings"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"10534e87-7a22-47f8-9307-ed017aab86c3"},{"name":"API Print","event":[{"listen":"test","script":{"id":"14ec8cb8-9e43-4e74-a416-06e3da82dff9","exec":["var template = `","","",""," "," "," "," "," "," "," "," "," "," ","

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

","`;","","function constructVisualizerPayload() {"," return { response: pm.response.json() }","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"12fe32c8-edb2-4386-9bd3-f2ad5a0e868d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"password\": \"badssl.com\",\n \"hosts\": [\"badssl.com\"],\n \"base64\": \"MIIK4QIBAzCCCqcGCSqGSIb3DQEHAaCCCpgEggqUMIIKkDCCBUcGCSqGSIb3DQEHBqCCBTgwggU0AgEAMIIFLQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQI/sMfVe2+YZYCAggAgIIFAJJIXcYicPxk5GRzW6daW2d4Bk23vyMPEjnwHnHWqp0nbZNzouGiSEzUCt73xu5kPTrl5jbAkgc7HFc5+RCiKtd153aeZlx5lhrrvRxE3+ozSyYJAbWbz4E4x/46OdAKKApDWuf0uD9T0x9l0FG8dOmjoWL/yU0aGesVpBppIV3FVPtbQManinXS9Mm6R/b6Cn+HgcmYfcIvg7VmQO9Z/Q6788UIT7Ztky+BZSidBAZ328S6Rar1WtBTQ6lxYI2KLgxZf8oN/FaAeLfu5eJ0raq6VE/+0imsBno4SXCbw+XsLjtDUPkjw3uXW4hWH3E2vypY+srtpeibAZ+7x/tdudkB+fmxPJJ9dMPKuIEHDHDQg3BnLGVljKBlyKv51l9sRwDcFoJoQi2WrvwwfPDuq1Se4QyJuzg9Cn84t6q3X/7iI5G46ZIcn/ugAcojSV4cc/Dt+IRdCyFM0nTbM4PkPUNeKB94xrdRL8Xof5Anp0d3OEU8Lyw7Xjt5OsNIxvTvsRZKrPCbYJod/Ng2mLinq/u+LYJ0HfWo8+O12chCU70DGUxnjGf0UudMrL1zOWq8IRtACtaC6JlAYQvK+3v+TRXBrE102V2YWQ6e9IcIDURtEcDfsAmA9cJ46R7ZnYgwjGNHnAubsubMcjBNDaZK5ttueSEkNSyT1F8MRdRLZJ2aU4i69p+bOOYCEMmM/fM9eXkyP5BOcwxsd61FzcHViVLKLdfyhZLxly91uRK7uU78iZGOe6lcE+ScP+UJJ0IT+e1nydUdlmjFHlZGH7yjoNhJg8XRcUcJbtxMActP6zhbv+I6cJq9NXoiGan1M8qbMUwF1LF+M0y8HDUoekImXyH+jecLPi5r3KLgP9QzzXuGy0BV8flxrbk8x5yox4tvE+Z9WM3V3A8m0ozF7geigKiFtJ4jvXSYLH34qxrcw1ep25EmdJVZbOEIiEAEdtcIKAciAjcz/pRcqpRfepajLPChfZdvA6tiwaN8HoHbJMmUB1mgANBga0ndxouOR1QiSYlJtQrYmZVh2HC3lwbOwSYLyMfp3D1c1yQNtX/8BJ9Z/3uJLCP1aOkAkUrbN9UXnSCX/nWsABlndXMNyFKaALecxRvVLl2r5Mz2Q4U8oR0PnO2S0UrzsV6aEQGuPVENRaeieNqYCFy4TeqdQNvd/CGDUQas4c8cqIrErVNZzQOMs9AEWlSu6cMI2hLri/nzjbTWyj4gMc+pGE++lGSWpviKyUFDNZlTViVKIQ7xKggoVwLQqza7eGqnzLKA+1TbrvU5nBh52UQsZ7wfejwkotSqmzKenpg7Y/zn408Ox+/x2SDaV7WqPiG56lleIilanDJYwhglq0kDO1xzmP1LXjnaJsb9sIlBPdflCPI/BWPIH/hgnkHtqhQma30GVfe/R9XpbrbKTnbmfWt+mESIt6Pb4w089g+5pvCNXqLTp7t3wx+knrRChuZfJrGHl2P22ekfC217m8v608bGh7NTzZCrKlEWYl5C5YMKNN9361kQ6j+V5KOhcRsi8pNB2/UmIX4bL9VcBpMz/gvIQAwLBxz3MtGRcL7MDAtUmLcKefWjIxAXH2sfY67QTOuCcjrhHD8+3LNcVOzeqiACPHzJlaTCD8sAK2Zxzzhw2IzIbvqRi1tR/kAzdjicpMhNL2nSVs1WrQNt5qIRro0nqxnK9lTE3lMGATAjoIjBoqXxD5tQMIIFQQYJKoZIhvcNAQcBoIIFMgSCBS4wggUqMIIFJgYLKoZIhvcNAQwKAQKgggTuMIIE6jAcBgoqhkiG9w0BDAEDMA4ECLiIU2IJd7YeAgIIAASCBMjCk9FSBEwwHUpLbvF/IvjafRknjtrIi9k4InPAC7IxW8pjG9Sxu6GfLGzY9/pbaJEsUN3fby8P4/lGZ7a2zMzGGxLHncbU37aRpxUelyMf4SGYnT+ClLv3cwnGNXEvPAYssIbPtPbOZ1rsspW4+ikEU4JM1RbGOLWJciUsCfvi9KGcSvHDhsTGh3PfihNvngty8VZazvNrOSiQWGu5iVhxGYrzvojFpmNF83gqMIQOwIrXwQEQVUT8MEZH9hl06TmmaieLIQXsxBQ1gjOJw/eHpJrtYi0GzS5HFClPNuLLs3sV0MfRRuDj16d7ImdlZowhKxEA85Mb90myXw2Z2vLYMsVzslM1VkzKhHWdKVWqWzeHFz0wMhc9IP4262YW6vTCXeAa9p+ZDZxg0d2t0Q4uURltq1BJZIIwG4EivxCI2lQUbz0o/QvXwHwvumvjHJb/7LZle/I12NTBhlPH/xdM+vdkDt76xsawFqCGKNMrI73ZGc6QqCrOHxMZVZUl+07npEfVtmjVeaRRdvjCAstB6qL3Z5trHXbqqMO7BT05kN+FRAJAYpx9v83Lv+Po527Iw8/BbFHFkS7RE1ypHP78IdOPRBvRcr+9UsKF8dRI12jGUoIO9vQJ+FVDrn2JtDZxgrCmdxxAo9/VTQXKEMVo+vT9AHwGk3joGUJztVHA1FWPP7va/yuIAWFiv/EYFuia22AQtq5rd7/r2nRHQ8JVAQ+nEHNXTFlqRNypC7Egs82v/EeNhfyb+OhUZ2YpmAgVnT5w3fME58Uj6x4Cs4tzjaI/qvA0/FE/RsfXUgEsPC266JFw4Y52oSBubn1s+T/CkAkVLGgZi130uRvzA0Y6d04r8SYaozQGyFbgoMCMT+1wV4iMfGh22K21d67aN/mu212EFj9fvQheNfOlKLLb+Kpc4JGZRYDH88U5rmapXqIcyOXgDuz6esTaLXQKrb+kNk9eVkQiiP2Yg5UM0gtMAPbOIMJjBFdPiGfW7MKny0j68MMY/su9ejFCo7cwqVmStUt/dT7lsrjfKXQwN9C0L6Y5vCWcodzeSgv5Yg+vgyVLTuhzGxOJTIZ6djMUm5NBQTzgbFFQTIEjNpiyI7/JgVMHVzxHR2cd6y188vqxkTyGGK1oxirvita5CD0PYghWRZYqYZabQKLsMC1WQWVy4jl6m1QI8GCMmIqlIbla4Qim3IOq+lClgA695cowYMrVpKuYJKZzQpxULHlaFthbVqjfnwHXy0sD6Bz+HPReMalt96tSuQbDjcxlevBPURdSOgrkNFC2P1LeTZ1Jxjqj2C0hVWk0f2fJz96KfWdz5HkP042Fr5Y8Y2DMGrD62dquCA9X5J9Ugm9O222QN+toyBWOHzX1FktzyfOpTJDqCGulHhLtBoRMcf1XJv+t6tB+tVvaMpsd2lNxpJmcCDAFt9T9eirPdM8Bm+fsiH1AhRdBN+HKlvCOUQDg5zz48yd7PSgWXJ8ZbAagn8vxswW90tMtmWrqu2Cg+c44SGyZJgrBvzmmC48fzb0yEGZW/9E3KHHzFKwmkMXBHhj5cHQnIZdaEJms1CRVDjrnSS6W1bCcxWHHo99YDMP/zvsjYYSRyJX5MY9DBJtojpSwJpwJAIzC5Rztb88xJTAjBgkqhkiG9w0BCRUxFgQUTHwp7Yz4OGGRNyRZpSE624OHyigwMTAhMAkGBSsOAwIaBQAEFFqqmv0NWakmVRF2zxvzC460dCY4BAjq0oCuVDoV/wICCAA=\"\n}","options":{"raw":{"language":"json"}}},"url":"http://:8081/api/v1/client_certificate","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"7d338fd5-8908-4287-978d-378d5542b681","id":"7d338fd5-8908-4287-978d-378d5542b681","name":"Kiosker API V.1","type":"collection"}},"urlObject":{"protocol":"http","port":"8081","path":["api","v1","client_certificate"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"12fe32c8-edb2-4386-9bd3-f2ad5a0e868d"},{"name":"API Client Certificate Hosts","event":[{"listen":"test","script":{"id":"14ec8cb8-9e43-4e74-a416-06e3da82dff9","exec":["var template = `","","",""," "," "," "," "," "," "," "," "," "," ","

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}

Error	Function	Status
{{response.error}}	{{response.function}}	{{response.status}}