{"info":{"_postman_id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","name":"CardTap Cloud Public API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"12281157","collectionId":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","publishedId":"TzsfkjMo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-08-01T03:10:26.000Z"},"item":[{"name":"Resources","item":[{"name":"Get Resource","id":"0defbef5-c8fd-4c0a-a3e6-146ffa4926b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.cardtapsystems.com/iot/resource?resource_id=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","name":"CardTap Cloud Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["iot","resource"],"host":["api","cardtapsystems","com"],"query":[{"description":{"content":"

Optionally specify resource_id to retrieve specific resource object

\n","type":"text/plain"},"key":"resource_id","value":""}],"variable":[]}},"response":[{"id":"c72bde08-723a-4d7e-9da3-967740025a52","name":"Resource Object","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cardtapsystems.com/iot/resource?resource_id=d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940","protocol":"https","host":["api","cardtapsystems","com"],"path":["iot","resource"],"query":[{"key":"resource_id","value":"d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940","description":"Optionally specify resource_id to retrieve specific resource object"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 May 2022 21:46:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"280"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"3fa7358a-2f2c-434a-bea6-30402ec78899"},{"key":"x-amz-apigw-id","value":"RhGdhEBRPHcFrNA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62705123-4708fbae7e593a4f3901db6e;Sampled=0"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"La Pavoni Espresso Machine\",\n \"resource_id\": \"d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940\",\n \"short_name\": \"Espresso Machine\",\n \"description\": \"BAR T3L-R La Pavoni 3 group espresso machine\",\n \"custom_identifier\": \"dbc1f802-a3f9-430d-8028-4f9740349118\",\n \"device_id\": \"7c9effffffff\"\n}"},{"id":"2df25e77-3ace-41dd-aba9-165c98f35ab1","name":"All Resource Objects","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cardtapsystems.com/iot/resource","protocol":"https","host":["api","cardtapsystems","com"],"path":["iot","resource"],"query":[{"key":"resource_id","value":"d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940","description":"Optionally specify resource_id to retrieve specific resource object","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 19 May 2022 20:43:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3409"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"e08b6a90-0528-4693-9965-7f0ab680fc3a"},{"key":"x-amz-apigw-id","value":"SY_ONEegvHcFiqw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6286abf4-1efbc02317b0e37629c73643;Sampled=0"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"CBBC Shop Lighting\",\n \"resource_id\": \"8cf5287f-1909-44c1-ac77-707a319187f2\",\n \"short_name\": \"Shop Lights\",\n \"description\": \"Demo 1\",\n \"custom_identifier\": \"null\",\n \"device_id\": \"84cca8553ee0\"\n },\n {\n \"name\": \"CBBC Shop Lighting\",\n \"resource_id\": \"8cf5287f-1909-44c1-ac77-707a319187f2\",\n \"short_name\": \"Shop Lights\",\n \"description\": \"Demo 1\",\n \"custom_identifier\": \"null\",\n \"device_id\": \"34865d4664b8\"\n },\n {\n \"name\": \"3D Printer\",\n \"resource_id\": \"3042b98b-d388-415f-aa68-85ea617b058c\",\n \"short_name\": \"Printer\",\n \"description\": \"Printer 1\",\n \"custom_identifier\": null,\n \"device_id\": null\n },\n {\n \"name\": \"Lite Demo\",\n \"resource_id\": \"b115fa02-ef38-4c31-ac86-433e57100039\",\n \"short_name\": \"Lite Test\",\n \"description\": \"test\",\n \"custom_identifier\": \"null\",\n \"device_id\": \"083af247a44c\"\n },\n {\n \"name\": \"La Pavoni Espresso Machine\",\n \"resource_id\": \"d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940\",\n \"short_name\": \"Espresso Machine\",\n \"description\": \"BAR T3L-R La Pavoni 3 group espresso machine\",\n \"custom_identifier\": \"dbc1f802-a3f9-430d-8028-4f9740349118\",\n \"device_id\": \"7c9effffffff\"\n }\n]"}],"_postman_id":"0defbef5-c8fd-4c0a-a3e6-146ffa4926b4"},{"name":"Create Resource","id":"6e753ba8-b541-4149-895d-b7182c598161","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"La Pavoni Espresso Machine\",\r\n \"short_name\": \"Espresso Machine\",\r\n \"description\": \"BAR T3L-R La Pavoni 3 group espresso machine\",\r\n \"custom_identifier\": \"dbc1f802-a3f9-430d-8028-4f9740349118\",\r\n \"hardware\": [\"7c9effffffff\",\"7c9efffffffe\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cardtapsystems.com/iot/resource","description":"

hardware is an array of device_id. Empty array is permitted.

Update any combination of resource parameters including name, short_name, description, and custom_identifier.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","name":"CardTap Cloud Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["iot","resource"],"host":["api","cardtapsystems","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"80a2243b-6dca-4541-b189-664f7b44d882"}],"id":"629851c8-6cac-41b1-b4d1-10b0231b2638","_postman_id":"629851c8-6cac-41b1-b4d1-10b0231b2638","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","name":"CardTap Cloud Public API","type":"collection"}}},{"name":"Hardware","item":[{"name":"Hardware Status","id":"283ad35a-4f54-45c9-b6a6-4b58dd5832c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.cardtapsystems.com/iot/status","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","name":"CardTap Cloud Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["iot","status"],"host":["api","cardtapsystems","com"],"query":[{"disabled":true,"key":"device_id","value":"c4dd5798b5d0"}],"variable":[]}},"response":[{"id":"d01641fa-64b2-4157-9d14-d133b477972a","name":"Hardware Status","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cardtapsystems.com/iot/status?device_id=c4dd5798b5d0","protocol":"https","host":["api","cardtapsystems","com"],"path":["iot","status"],"query":[{"key":"device_id","value":"c4dd5798b5d0"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 01 Aug 2021 03:07:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"275"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ced39fe7-dc2a-4b26-a4c6-81dd660ffc25"},{"key":"x-amz-apigw-id","value":"DXdspHnBvHcFsYQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-61060fea-68b3b4b7075199a722041f04;Sampled=0"}],"cookie":[],"responseTime":null,"body":"{\n \"mac_address\": \"c4dd5798b5d0\",\n \"resource_id\": \"d7a1b0b0-7aed-4b56-8baf-a1309678b4d6\",\n \"name\": \"c4dd5798b5d0\",\n \"display_name\": \"c4dd5798b5d0\",\n \"description\": \"null\",\n \"current_status\": \"offline\",\n \"last_seen\": \"2021-07-14 02:28:04\",\n \"ssid\": \"The TK Suite\",\n \"ip_address\": \"192.168.0.164\",\n \"wifi_rssi\": -25,\n \"battery_percentage\": 100\n}"}],"_postman_id":"283ad35a-4f54-45c9-b6a6-4b58dd5832c1"},{"name":"Hardware Association","id":"fd4c689b-c003-4f82-a2b9-181abaf7b6b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.cardtapsystems.com/iot/hardware/allocation?filter=","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","name":"CardTap Cloud Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["iot","hardware","allocation"],"host":["api","cardtapsystems","com"],"query":[{"description":{"content":"

Optionally retrieve only 'allocated' or 'unallocated' hardware

\n","type":"text/plain"},"key":"filter","value":""}],"variable":[]}},"response":[{"id":"5f557625-44d9-4ccf-a653-3da0a1319d2c","name":"All","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cardtapsystems.com/iot/hardware/allocation","protocol":"https","host":["api","cardtapsystems","com"],"path":["iot","hardware","allocation"],"query":[{"key":"filter","value":"all","description":"Optionally retrieve only 'allocated' or 'unallocated' hardware","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Apr 2022 22:44:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1562"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"67d11f85-3317-468f-a7b2-69f2ff51ac07"},{"key":"x-amz-apigw-id","value":"RKKanEQEvHcFVfw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-62672443-7979865b68b6974444a8c650;Sampled=0"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"mac_address\": \"943cc62b9a84\",\n \"device_id\": \"943cc62b9a84\",\n \"resource_id\": \"f28a4af1-a795-492e-bb9d-ec1f770107ed\",\n \"allocated\": 1\n },\n {\n \"mac_address\": \"083af247a44c\",\n \"device_id\": \"083af247a44c\",\n \"resource_id\": null,\n \"allocated\": 0\n },\n {\n \"mac_address\": \"84cca8553ee0\",\n \"device_id\": \"84cca8553ee0\",\n \"resource_id\": \"8cf5287f-1909-44c1-ac77-707a319187f2\",\n \"allocated\": 1\n },\n {\n \"mac_address\": \"30c6f7e43be0\",\n \"device_id\": \"30c6f7e43be0\",\n \"resource_id\": \"b115fa02-ef38-4c31-ac86-433e57100039\",\n \"allocated\": 1\n }\n]"},{"id":"5f18e509-c5bb-4a3d-b45d-61fc471c28db","name":"Unallocated","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cardtapsystems.com/iot/hardware/allocation?filter=unallocated","protocol":"https","host":["api","cardtapsystems","com"],"path":["iot","hardware","allocation"],"query":[{"key":"filter","value":"unallocated","description":"Optionally retrieve only 'allocated' or 'unallocated' hardware"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Apr 2022 22:44:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"86abdc82-a2c9-4875-8aff-690afaf64d59"},{"key":"x-amz-apigw-id","value":"RKKeJHAkvHcFjZA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6267245a-15dca0bf3e5a4e210d4c8ff6;Sampled=0"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"mac_address\": \"083af247a44c\",\n \"device_id\": \"083af247a44c\",\n \"allocated\": 0\n }\n]"},{"id":"347b7402-49d9-4aaf-9176-7aaa4ba6d8e4","name":"Allocated","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cardtapsystems.com/iot/hardware/allocation?filter=allocated","protocol":"https","host":["api","cardtapsystems","com"],"path":["iot","hardware","allocation"],"query":[{"key":"filter","value":"allocated","description":"Optionally retrieve only 'allocated' or 'unallocated' hardware"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Apr 2022 22:45:02 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1463"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"b3a25809-4423-4629-9df0-a761329aced9"},{"key":"x-amz-apigw-id","value":"RKKhPGKPPHcFhSA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6267246e-501c1a9536240d2f237a2cd7;Sampled=0"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"mac_address\": \"943cc62b9a84\",\n \"device_id\": \"943cc62b9a84\",\n \"resource_id\": \"f28a4af1-a795-492e-bb9d-ec1f770107ed\",\n \"allocated\": 1\n },\n {\n \"mac_address\": \"84cca8553ee0\",\n \"device_id\": \"84cca8553ee0\",\n \"resource_id\": \"8cf5287f-1909-44c1-ac77-707a319187f2\",\n \"allocated\": 1\n },\n {\n \"mac_address\": \"30c6f7e43be0\",\n \"device_id\": \"30c6f7e43be0\",\n \"resource_id\": \"b115fa02-ef38-4c31-ac86-433e57100039\",\n \"allocated\": 1\n }\n]"}],"_postman_id":"fd4c689b-c003-4f82-a2b9-181abaf7b6b7"},{"name":"WPA2 Enterprise Config","id":"73abc7c3-977e-4f34-b768-6a1d640ba0f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"device_id\": \"7c9effffffff\",\r\n \"wpa2e_ssid\": \"SSID\",\r\n \"wpa2e_id\": \"Identity\",\r\n \"wpa2e_username\": \"Username\",\r\n \"wpa2e_password\": \"Password\",\r\n \"force_config_reconnect\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cardtapsystems.com/iot/network/wificonfig","description":"

device_id (Unique ID of CardTap device)
\nwpa2e_ssid (WPA2 Enterprise Network SSID)
\nwpa2e_id (WPA2 Enterprise Identity)
\nwpa2e_username (WPA2 Enterprise Username)
\nwpa2e_password (WPA2 Enterprise Password)

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","name":"CardTap Cloud Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["iot","network","wificonfig"],"host":["api","cardtapsystems","com"],"query":[],"variable":[]}},"response":[{"id":"c741661b-7390-444f-8c6c-6b95bad1b65e","name":"WPA2 Enterprise Config","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"device_id\": \"7c9effffffff\",\r\n \"wpa2e_ssid\": \"SSID\",\r\n \"wpa2e_id\": \"Identity\",\r\n \"wpa2e_username\": \"Username\",\r\n \"wpa2e_password\": \"Password\",\r\n \"force_config_reconnect\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cardtapsystems.com/iot/network/wificonfig"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 31 Jul 2021 01:33:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"125"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"bb8c08f6-ec0d-4a05-9ec3-fe6916c38f39"},{"key":"x-amz-apigw-id","value":"DT8-yFdMvHcF85w="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6104a85e-4eb775dc346be43f19f1f84e;Sampled=0"}],"cookie":[],"responseTime":null,"body":"A WiFi configuration update on device with id: 7c9effffffff has been accepted by CardTap Cloud and pushed to hardware device."}],"_postman_id":"73abc7c3-977e-4f34-b768-6a1d640ba0f6"},{"name":"Allocate Hardware to Resource","id":"d97dee84-0e90-4687-90cb-c4253fb8f507","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resource_id\": \"d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940\",\r\n \"device_id\": \"7c9effffffff\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cardtapsystems.com/iot/hardware/allocate","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","name":"CardTap Cloud Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["iot","hardware","allocate"],"host":["api","cardtapsystems","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d97dee84-0e90-4687-90cb-c4253fb8f507"},{"name":"Deallocate Hardware from Resource","id":"150d0f78-f9cf-4fae-9fa0-64d9d0c97e71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"device_id\": \"7c9effffffff\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cardtapsystems.com/iot/hardware/deallocate","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","name":"CardTap Cloud Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["iot","hardware","deallocate"],"host":["api","cardtapsystems","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"150d0f78-f9cf-4fae-9fa0-64d9d0c97e71"}],"id":"8347d297-bda5-42a0-9177-34ae75dbd623","_postman_id":"8347d297-bda5-42a0-9177-34ae75dbd623","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","id":"fc114ad6-d34e-4b71-b2a3-d64b3ee45da5","name":"CardTap Cloud Public API","type":"collection"}}},{"name":"Authentication Request Webhook","id":"4b74d4be-5cfa-4ae7-a015-6ba7963fc0f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{3rd party endpoint url}?event_id=&device_id=&resource_id&facility_code&card_code&action&external_reference","description":"

Takes login event from CardTap hardware and requests authentication from 3rd party where applicable. Not used with CardTap managed clients.

\n","urlObject":{"host":["{3rd party endpoint url}"],"query":[{"description":{"content":"

UUID of login event for tracking the request

\n","type":"text/plain"},"key":"event_id","value":""},{"description":{"content":"

Physical MAC address of CardTap device that the login request originated from

\n","type":"text/plain"},"key":"device_id","value":""},{"description":{"content":"

UUID of CardTap resource that the login request originated from

\n","type":"text/plain"},"key":"resource_id","value":null},{"key":"facility_code","value":null},{"key":"card_code","value":null},{"description":{"content":"

'login' or 'logout'

\n","type":"text/plain"},"key":"action","value":null},{"description":{"content":"

Optionally set custom identifer provided by 3rd party systems

\n","type":"text/plain"},"key":"external_reference","value":null}],"variable":[]}},"response":[{"id":"30e6443d-50a2-492b-ab6c-430f198eac1b","name":"Login - Authorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://webhook.site/ec973933-94d1-4573-9fc9-f2a325618702?event_id=8aaf2200-cb78-1229-8800-34865d4664b8&device_id=34865d4664b8&resource_id=8cf5287f-1909-44c1-ac77-707a319187f2&facility_code=212&card_code=52378&action=login&external_reference=1084","protocol":"https","host":["webhook","site"],"path":["ec973933-94d1-4573-9fc9-f2a325618702"],"query":[{"key":"event_id","value":"8aaf2200-cb78-1229-8800-34865d4664b8","description":"UUID of login event for tracking the request"},{"key":"device_id","value":"34865d4664b8","description":"Physical MAC address of CardTap device that the login request originated from"},{"key":"resource_id","value":"8cf5287f-1909-44c1-ac77-707a319187f2","description":"UUID of CardTap resource that the login request originated from"},{"key":"facility_code","value":"212"},{"key":"card_code","value":"52378"},{"key":"action","value":"login","description":"'login' or 'logout'"},{"key":"external_reference","value":"1084","description":"Optionally set custom identifer provided by 3rd party systems"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Request-Id","value":"e35489b8-0ad7-4132-b9e2-1533ca5ec74d"},{"key":"X-Token-Id","value":"ec973933-94d1-4573-9fc9-f2a325618702"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 11 Jan 2022 19:11:04 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"firstName\": \"Taylor\",\n \"lastName\": \"Amarotico\",\n \"message\": \"authorized\"\n}"},{"id":"c6ec39d7-9dea-443b-aed5-b655b153f00d","name":"Login - Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://webhook.site/ec973933-94d1-4573-9fc9-f2a325618702?event_id=8aaf2200-cb78-1229-8800-34865d4664b8&device_id=34865d4664b8&resource_id=8cf5287f-1909-44c1-ac77-707a319187f2&facility_code=212&card_code=52378&action=login&external_reference=1084","protocol":"https","host":["webhook","site"],"path":["ec973933-94d1-4573-9fc9-f2a325618702"],"query":[{"key":"event_id","value":"8aaf2200-cb78-1229-8800-34865d4664b8","description":"UUID of login event for tracking the request"},{"key":"device_id","value":"34865d4664b8","description":"Physical MAC address of CardTap device that the login request originated from"},{"key":"resource_id","value":"8cf5287f-1909-44c1-ac77-707a319187f2","description":"UUID of CardTap resource that the login request originated from"},{"key":"facility_code","value":"212"},{"key":"card_code","value":"52378"},{"key":"action","value":"login","description":"'login' or 'logout'"},{"key":"external_reference","value":"1084","description":"Optionally set custom identifer provided by 3rd party systems"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Request-Id","value":"e35489b8-0ad7-4132-b9e2-1533ca5ec74d"},{"key":"X-Token-Id","value":"ec973933-94d1-4573-9fc9-f2a325618702"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 11 Jan 2022 19:11:04 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"message\": \"unauthorized\"\n}"},{"id":"566d3793-8036-4e66-9737-9934df52dfd2","name":"Login - Unknown User (or other error)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://webhook.site/ec973933-94d1-4573-9fc9-f2a325618702?event_id=8aaf2200-cb78-1229-8800-34865d4664b8&device_id=34865d4664b8&resource_id=8cf5287f-1909-44c1-ac77-707a319187f2&facility_code=212&card_code=52378&action=login&external_reference=1084","protocol":"https","host":["webhook","site"],"path":["ec973933-94d1-4573-9fc9-f2a325618702"],"query":[{"key":"event_id","value":"8aaf2200-cb78-1229-8800-34865d4664b8","description":"UUID of login event for tracking the request"},{"key":"device_id","value":"34865d4664b8","description":"Physical MAC address of CardTap device that the login request originated from"},{"key":"resource_id","value":"8cf5287f-1909-44c1-ac77-707a319187f2","description":"UUID of CardTap resource that the login request originated from"},{"key":"facility_code","value":"212"},{"key":"card_code","value":"52378"},{"key":"action","value":"login","description":"'login' or 'logout'"},{"key":"external_reference","value":"1084","description":"Optionally set custom identifer provided by 3rd party systems"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Request-Id","value":"e35489b8-0ad7-4132-b9e2-1533ca5ec74d"},{"key":"X-Token-Id","value":"ec973933-94d1-4573-9fc9-f2a325618702"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 11 Jan 2022 19:11:04 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"Card not found\"\n}"},{"id":"1f6986ad-07ef-4246-8cb0-e7f005a13e34","name":"Logout","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://webhook.site/ec973933-94d1-4573-9fc9-f2a325618702?event_id=8aaf2200-cb78-1229-8800-34865d4664b8&device_id=34865d4664b8&resource_id=8cf5287f-1909-44c1-ac77-707a319187f2&action=logout&external_reference=1084","protocol":"https","host":["webhook","site"],"path":["ec973933-94d1-4573-9fc9-f2a325618702"],"query":[{"key":"event_id","value":"8aaf2200-cb78-1229-8800-34865d4664b8","description":"UUID of login event for tracking the request"},{"key":"device_id","value":"34865d4664b8","description":"Physical MAC address of CardTap device that the login request originated from"},{"key":"resource_id","value":"8cf5287f-1909-44c1-ac77-707a319187f2","description":"UUID of CardTap resource that the login request originated from"},{"key":"facility_code","value":"212","disabled":true},{"key":"card_code","value":"52378","disabled":true},{"key":"action","value":"logout","description":"'login' or 'logout'"},{"key":"external_reference","value":"1084","description":"Optionally set custom identifer provided by 3rd party systems"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Request-Id","value":"e35489b8-0ad7-4132-b9e2-1533ca5ec74d"},{"key":"X-Token-Id","value":"ec973933-94d1-4573-9fc9-f2a325618702"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Tue, 11 Jan 2022 19:11:04 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4b74d4be-5cfa-4ae7-a015-6ba7963fc0f6"},{"name":"Create Resource with Hardware","id":"fc435663-c970-45d4-9e70-d9f7c1c5784b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"device_id\": \"7c9effffffff\",\r\n \"name\": \"La Pavoni Espresso Machine\",\r\n \"short_name\": \"Espresso Machine\",\r\n \"description\": \"BAR T3L-R La Pavoni 3 group espresso machine\",\r\n \"custom_identifier\": \"dbc1f802-a3f9-430d-8028-4f9740349118\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cardtapsystems.com/iot/resource-with-hardware","description":"

device_id (Unique ID of CardTap device)

name (Resource name)

short_name (16 character maximum resource nickname displayed on CardTap hardware)

description (Optional description of resource for reference only)

custom_identifier (Optional client provided custom identifier included in every authentication webhook request to client's system)

UUID of CardTap resource

\n","type":"text/plain"},"key":"resource_id","value":""},{"description":{"content":"

Desired override state: 'login', 'logout', 'enable', 'disable'

\n","type":"text/plain"},"key":"state","value":""},{"description":{"content":"

Required for 'login' override

\n","type":"text/plain"},"key":"first_name","value":""},{"description":{"content":"

Required for 'login' override

\n","type":"text/plain"},"key":"last_name","value":""},{"description":{"content":"

Message displayed on device on 'disable' override

\n","type":"text/plain"},"key":"message","value":""}],"variable":[]}},"response":[{"id":"eb15029c-dcd0-4d09-be73-013e0fe3f76d","name":"login","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://api.cardtapsystems.com/iot/resource-state?resource_id=d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940&state=login&first_name=John&last_name=Doe","protocol":"https","host":["api","cardtapsystems","com"],"path":["iot","resource-state"],"query":[{"key":"resource_id","value":"d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940","description":"UUID of CardTap resource"},{"key":"state","value":"login","description":"Desired override state: 'login', 'logout', 'enable', 'disable'"},{"key":"first_name","value":"John","description":"Required for 'login' override"},{"key":"last_name","value":"Doe","description":"Required for 'login' override"},{"key":"message","value":null,"description":"Message displayed on device on 'disable' override","disabled":true}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 19 May 2022 21:31:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"109"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"6d3ba42b-34ed-48ef-b259-473bfdb823c5"},{"key":"x-amz-apigw-id","value":"SZGQOHVHPHcFtFg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6286b734-0c6a956e40bb2e7c3384cf54;Sampled=0"}],"cookie":[],"responseTime":null,"body":"A state of authorized has successfully been pushed to resource with id: d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940."},{"id":"82efd42c-bcf1-4e75-9499-eb312bdde6e2","name":"logout","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://api.cardtapsystems.com/iot/resource-state?resource_id=d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940&state=logout","protocol":"https","host":["api","cardtapsystems","com"],"path":["iot","resource-state"],"query":[{"key":"resource_id","value":"d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940","description":"UUID of CardTap resource"},{"key":"state","value":"logout","description":"Desired override state: 'login', 'logout', 'enable', 'disable'"},{"key":"first_name","value":"John","description":"Required for 'login' override","disabled":true},{"key":"last_name","value":"Doe","description":"Required for 'login' override","disabled":true},{"key":"message","value":null,"description":"Message displayed on device on 'disable' override","disabled":true}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 19 May 2022 21:32:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"106"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"053e563e-5bfe-470f-b57d-b76a8094aa3c"},{"key":"x-amz-apigw-id","value":"SZGc0FidPHcFaPg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6286b785-0b86e7b07c234b4a12ed96b2;Sampled=0"}],"cookie":[],"responseTime":null,"body":"A state of standby has successfully been pushed to resource with id: d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940."},{"id":"586cffd2-ff77-4bc0-8aec-67a295e1c62b","name":"disable","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://api.cardtapsystems.com/iot/resource-state?resource_id=d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940&state=disable&message=Offline for maintenance","protocol":"https","host":["api","cardtapsystems","com"],"path":["iot","resource-state"],"query":[{"key":"resource_id","value":"d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940","description":"UUID of CardTap resource"},{"key":"state","value":"disable","description":"Desired override state: 'login', 'logout', 'enable', 'disable'"},{"key":"first_name","value":"John","description":"Required for 'login' override","disabled":true},{"key":"last_name","value":"Doe","description":"Required for 'login' override","disabled":true},{"key":"message","value":"Offline for maintenance","description":"Message displayed on device on 'disable' override"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 19 May 2022 21:33:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"122"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"34ed8021-f9c9-42b4-92fe-c9db71b86f7a"},{"key":"x-amz-apigw-id","value":"SZGkaEySvHcFrTg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6286b7b5-4d87082c5b751d3c25032033;Sampled=0"}],"cookie":[],"responseTime":null,"body":"A state of Offline for maintenance has successfully been pushed to resource with id: d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940."},{"id":"b00bf360-92ae-4bc8-80a1-4a7c554d8b00","name":"enable","originalRequest":{"method":"PUT","header":[],"url":{"raw":"https://api.cardtapsystems.com/iot/resource-state?resource_id=d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940&state=enable","protocol":"https","host":["api","cardtapsystems","com"],"path":["iot","resource-state"],"query":[{"key":"resource_id","value":"d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940","description":"UUID of CardTap resource"},{"key":"state","value":"enable","description":"Desired override state: 'login', 'logout', 'enable', 'disable'"},{"key":"first_name","value":"John","description":"Required for 'login' override","disabled":true},{"key":"last_name","value":"Doe","description":"Required for 'login' override","disabled":true},{"key":"message","value":"Offline for maintenance","description":"Message displayed on device on 'disable' override","disabled":true}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 19 May 2022 21:33:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"106"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"0bfecbdc-f302-439b-8009-69a1209f2887"},{"key":"x-amz-apigw-id","value":"SZGmKFLCvHcF4lw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-6286b7c0-372cd8c11952a3c24c32bfd5;Sampled=0"}],"cookie":[],"responseTime":null,"body":"A state of standby has successfully been pushed to resource with id: d4c99ecf-5cbb-4c6c-853f-9ed26fb8b940."}],"_postman_id":"aa637b58-0884-4642-a0ba-44e213421674"},{"name":"Resource Name (deprecated)","id":"1137429d-fed5-4d6d-b3c9-e1e495dcf3a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"device_id\": \"7c9effffffff\",\r\n \"display_name\": \"Device display name, 16 characters max\",\r\n \"name\": \"Device name, <50 characters\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.cardtapsystems.com/iot/name","description":"

\"device_id\": \"Unique ID of CardTap device\"
\n\"display_name\": \"Device display name, 16 characters max\"
\n\"name\": \"Device name, <50 characters\"

\nRequest must include device_id AND display_name and/or name

wpa2e_ssid (WPA2 Enterprise Network SSID)
\nwpa2e_id (WPA2 Enterprise Identity)
\nwpa2e_username (WPA2 Enterprise Username)
\nwpa2e_password (WPA2 Enterprise Password)
\ncredential_ttl (TTL in hours till credentials are no longer pushed to new hardware. This helps protect devices from receiving expired credentials and requiring a manual reconfiguration)