This API exposes some set of functionalities required in order to check-in a guest/visitor using the SKYACCESS.
\nThe owner of the property must allow your account permissions to perform operation such as opening the doors and related functions
\nYour login data and base url will be provided via email, kindly contact AMADEO or his Partners for that purpose. Those can be generated using our IntegrA Admin Platform as well.
\nGet the access token using your login data, then use the token within the header in each request
\nSynchronize the door list, it returns a list of doors and their related status such as: \nDoor status, Battery status, Door alarm status, Online status, The door name and the ID, etc..
\nyou are now ready to call other APIs, some required data such as persons, access card, profiles etc.. will be generated for you in the background within the limit allowed by your account.
\nThe Call to the REST API is done by using the Oauth2.0 protocol to authorize access to the allowed resources.
\nThe Token is valid within a given time, the life time of the token is specified as well, the application integrator should be able to handle the Token life time and decide to request for another once it has expired or is compromised.
\nNote:\nThe default Token expiry date is within 15 days, the application should make sure to request a new token when the previous one has expired.
\nNote:\nEach resource called will return an object within the body with the properties \"error_code\" and \"message\" if an error has occurred during the request.\nEach resource has his own error description
\n0 - The transaction has been done successfully without any error
\n1100 - Either the Initial date or expiration date is not well formatted \nOr the expire date is earlier than the initial date and vice versa.
\n1101 - One of the rooms on the list does not exist.
\n-1 - An exception has been triggered, fatal error.
\n15 - Bad request, the given json parameter is not well formatted, check the sample code.
\n684 - The expire date should be greater than the initial date
\netc.., all error codes triggered by a request has a body description.
\nThe Services allows 50 calls within a 10 seconds of time window per IP Address and location, if this requirement is not met, the error TOO MANY REQUESTS will be triggered. In this case, make a retry according to the limitation set above.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"HTTP Error Codes","slug":"http-error-codes"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"15069670","collectionId":"a70b6faf-cb42-45ed-82d5-e1eb1b6080b2","publishedId":"TzCFgASm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"000000","highlight":"EF5B25"},"publishDate":"2021-05-12T09:09:19.000Z"},"item":[{"name":"GetToken","id":"cfe80caf-b72f-496f-9306-91d5642e5a37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic bWF0dDplZWU="},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"root@amadeosystems.com","type":"text"},{"key":"password","value":"Mc90210!","type":"text"},{"key":"grant_type","value":"password","type":"text"}]},"url":"{{uri}}/Account/Token","description":"The token is unique and can be multiple time renewed once he has expired .
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"a70b6faf-cb42-45ed-82d5-e1eb1b6080b2","id":"a70b6faf-cb42-45ed-82d5-e1eb1b6080b2","name":"SkyAccess Guest - Edition v1","type":"collection"}},"urlObject":{"path":["Account","Token"],"host":["{{uri}}"],"query":[],"variable":[]}},"response":[{"id":"d341b279-3aa0-4a89-a3a2-7845adf3f186","name":"GetToken","originalRequest":{"method":"POST","header":[{"key":"User","value":"matts11","disabled":true},{"key":"ExpireDate","value":"24.10.2017","disabled":true},{"key":"Authorization","value":"Basic bWF0dDplZWU=","disabled":true},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"grant_type","value":"password"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"RGV2ZWxvcGVyLkRlbW8KCg","type":"text"},{"key":"password","value":"U3RheU15d2F5MjAyMCEhIQoK","type":"text"},{"key":"grant_type","value":"password","type":"text"}]},"url":"{{uri}}/Account/Token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Set-Cookie","value":".AspNet.Cookies=E54VaCs2tenRMnTvSkXQH26zQ001aa9oQ4m9SKAFZ65U6wnBz_noApatPuTpyxJtPG8lFFBz1suJ_mvbMi1GzwhmrxbK-oypXZXYtZSkWqZr_nGx8OqCtFQkJgdTpKQe0fpZWCR7rH6tDSLAZNbBvFTt32edU_2__QKFn1MRG0nezWPDKmq6564Y4I5e6KPXaZWDvYxQZFCI1NI71DyD4njW8z8aDVE0jxO4xgxssfJA4xjleIA32mRXqQ0QMtlhEcxUoAee7T4A70VNUDM2MPo0LUYK2nKFHk21Pe5X1POv8qZ5e2FcmBlA32MpDCY0YIJsfMA0GzA-_FQ3BgrRcwtP9HPZrZLAXYeVyr6-KYwfq8GR850VESdt0iADOzjiOq67dZBt3NLZDHJ7txiuXGK8SeKEYrbka4NYZnyANCIQz8wUXIjVEwx7_EauUGQbml4ATqcGKkiGgM02Iv2RDQ; path=/; HttpOnly"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcQW1hZGVvXDEgLSBTb2Z0d2FyZXNcV2ViIEFwcGxpY2F0aW9uc1wyIC0gV2ViU2VydmljZXNcQW1hZGVvV2ViU2VydmljZXNcUmVzdFdlYkFwaVxhcGlcdjFcQWNjb3VudFxUb2tlbg==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Date","value":"Wed, 12 May 2021 03:03:14 GMT"},{"key":"Content-Length","value":"656"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"n3NRlGLiLXV6PnD-d3fcONDSw-_oMiF1E5FpaicatoAlz8aet7FGBj41gYKhcVr9Ef2rlOHs3K5dVlXzWQf1_DX11RznPdMrQbL-Xe85lyKJ3UL2V4ysrWs7YZHF4E-ZTs1TER-PU_hQnJ34po5ZMCvFqHijrC1pLkmNWtkSG2GEp5nMBFQtkujHmI4LVU-MbO_GJiypix435lB5omePXIg4vTTws8C1nsYPyg76FhPeUvF9HuPalWaXLiArrvRVytqDkIVVYthUwZCWgSxOPdlQsmxhYudvoVKjMB7_XsS0l2ALw3UVrGqeaAWRM_Pg9rdUiaE7rnfbUmXViCeb1z5yADw2eXIROB6FcY5vNk6E9D20yOuSgETDONCtJP3uK4afyrM-ofGHixaCbUfudrx8QzwXpLUxVRqg0gYOcpGaWw1ZzL7_BLQZbBKiGQkowKU1jKraPaINpqRjie1XRGBK-P676rjfT8KhamqN6VA\",\n \"token_type\": \"bearer\",\n \"expires_in\": 1295999,\n \"userName\": \"root\",\n \".issued\": \"Wed, 12 May 2021 03:03:13 GMT\",\n \".expires\": \"Thu, 27 May 2021 03:03:13 GMT\"\n}"}],"_postman_id":"cfe80caf-b72f-496f-9306-91d5642e5a37"},{"name":"SyncDoorList","id":"b0671536-49a7-4f80-bbaa-78a47af9ec27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":"{{uri}}/Door/SyncDoorList","description":"SyncDoorList return the list of doors with their related status
\nSyncDoorList return the list of doors with their related status
\nGet some basic status of a target door \nor search for a door by name.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"a70b6faf-cb42-45ed-82d5-e1eb1b6080b2","id":"a70b6faf-cb42-45ed-82d5-e1eb1b6080b2","name":"SkyAccess Guest - Edition v1","type":"collection"}},"urlObject":{"path":["Door","GetDoorStatusByName","101"],"host":["{{uri}}"],"query":[],"variable":[]}},"response":[{"id":"f17e7741-c9e8-4a4e-95f0-08a664a61ba2","name":"GetDoorStatusByName","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":"{{uri}}/Door/GetDoorStatusByName/10"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcQW1hZGVvXDEgLSBTb2Z0d2FyZXNcV2ViIEFwcGxpY2F0aW9uc1wyIC0gV2ViU2VydmljZXNcQW1hZGVvV2ViU2VydmljZXNcUmVzdFdlYkFwaVxhcGlcdjFcRG9vclxHZXREb29yU3RhdHVzQnlOYW1lXDEw?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Date","value":"Tue, 11 May 2021 20:59:37 GMT"},{"key":"Content-Length","value":"429"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"DoorID\": 596,\n \"_DoorName\": \"10Pantry_A\",\n \"_OnlineStatus\": 0,\n \"_BatteryStatus\": 0,\n \"_DoorState\": 0,\n \"_DoorAlarm\": 0\n },\n {\n \"DoorID\": 597,\n \"_DoorName\": \"10Pantry_B\",\n \"_OnlineStatus\": 0,\n \"_BatteryStatus\": 0,\n \"_DoorState\": 0,\n \"_DoorAlarm\": 0\n },\n {\n \"DoorID\": 598,\n \"_DoorName\": \"10Pantry_C\",\n \"_OnlineStatus\": 0,\n \"_BatteryStatus\": 0,\n \"_DoorState\": 0,\n \"_DoorAlarm\": 0\n },\n {\n \"DoorID\": 599,\n \"_DoorName\": \"10Pantry_D\",\n \"_OnlineStatus\": 0,\n \"_BatteryStatus\": 0,\n \"_DoorState\": 0,\n \"_DoorAlarm\": 0\n }\n]"}],"_postman_id":"f925ad1b-6f73-4488-81f2-0829578dc62f"},{"name":"GetDoorsStatusByMUR","id":"f9d5299c-650c-4b26-b854-ff026cd2ac71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":"{{uri}}/Door/GetDoorsStatusByMUR","description":"Get all doors which have the MUR (Make Up Room) state activated within the installation
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"a70b6faf-cb42-45ed-82d5-e1eb1b6080b2","id":"a70b6faf-cb42-45ed-82d5-e1eb1b6080b2","name":"SkyAccess Guest - Edition v1","type":"collection"}},"urlObject":{"path":["Door","GetDoorsStatusByMUR"],"host":["{{uri}}"],"query":[],"variable":[]}},"response":[{"id":"a20c2d9e-ca3e-4a4a-b044-6c479b9a96e6","name":"GetDoorsStatusByMUR","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":"{{uri}}/Door/GetDoorsStatusByMUR"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcQW1hZGVvXDEgLSBTb2Z0d2FyZXNcV2ViIEFwcGxpY2F0aW9uc1wyIC0gV2ViU2VydmljZXNcQW1hZGVvV2ViU2VydmljZXNcUmVzdFdlYkFwaVxhcGlcdjFcRG9vclxHZXREb29yc1N0YXR1c0J5TVVS?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Date","value":"Tue, 11 May 2021 20:59:50 GMT"},{"key":"Content-Length","value":"2"}],"cookie":[],"responseTime":null,"body":"[]"}],"_postman_id":"f9d5299c-650c-4b26-b854-ff026cd2ac71"},{"name":"GetDoorsStatusByDND","id":"cbdb462d-c3cd-447e-a502-193bed34f88d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":"{{uri}}/Door/GetDoorsStatusByDND","description":"Get all doors which have the DND (Do no Disturb) state activated within the installation
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"a70b6faf-cb42-45ed-82d5-e1eb1b6080b2","id":"a70b6faf-cb42-45ed-82d5-e1eb1b6080b2","name":"SkyAccess Guest - Edition v1","type":"collection"}},"urlObject":{"path":["Door","GetDoorsStatusByDND"],"host":["{{uri}}"],"query":[],"variable":[]}},"response":[{"id":"e0e32e97-c4f1-43cc-aaf5-7963e2f60115","name":"GetDoorsStatusByDND","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":"{{uri}}/Door/GetDoorsStatusByDND"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcQW1hZGVvXDEgLSBTb2Z0d2FyZXNcV2ViIEFwcGxpY2F0aW9uc1wyIC0gV2ViU2VydmljZXNcQW1hZGVvV2ViU2VydmljZXNcUmVzdFdlYkFwaVxhcGlcdjFcRG9vclxHZXREb29yc1N0YXR1c0J5RE5E?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Date","value":"Tue, 11 May 2021 20:59:57 GMT"},{"key":"Content-Length","value":"101"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"DoorID\": 71,\n \"_DoorName\": \"3160\",\n \"_OnlineStatus\": 1,\n \"_BatteryStatus\": 1,\n \"_DoorState\": 6,\n \"_DoorAlarm\": 0\n }\n]"}],"_postman_id":"cbdb462d-c3cd-447e-a502-193bed34f88d"},{"name":"GetLastDoorAuditoriesByName","id":"3b32b229-3ab0-4d86-8526-e3007f4d9bc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"url":"{{uri}}/DoorAuditories/GetLastDoorAuditoriesByName/102/1/10","description":"Get the events of a particular door by providing the following parameter
\nGetLastDoorAuditoriesByName/RoomName/Page/count
\nThe list of events returned are mapped as follow :
\nGet the events of all doors by providing the following parameter
\nGetLastDoorAuditories/Page/count
\nEvent list descriptions :
\nOpen door request, the door is not directly opened, instead a task will be queued within the system for further verifications.\nthen once the Guest tab the device reader with the phone, then a kind of 2 way verification will be done within a configurable time frame so the the can be opened.\nthe time frame range is 5s - 1Hour.\nwithin this range the system expect the user to tab the phone on the reader, otherwise, the token will expire.
\nSK_OpenDoorByGuest/RoomName
\nthe owner is reponsible to configure the related doors which the Guest / Visitor will have access to including the Main Room.
\nGenerally, only the main Room access will be requested, depending of the system configuration additional rooms access will be added and a common token will be created.
\nthe following parameters will be provided :
\ngenerally the system is pre-configured in order to allow or not those features.
\nThis Endpoint has the same behavior as the\nSK_OpenDoorByGuest.
\nthe only difference is that the door when opened stay/remains opened until a valid card or the close API is used in order to close the door back to his default position.
\nThis Endpoint has the same behavior as the\nSK_OpenDoorByGuest but do not open the door.
\nHe returns an encrypted token that can be send back to the API for validation in order to perform some order actions such as :
\nNote: the Token length is variable according to the door/ access/ security level.
\nThe purpose of this API is the validate a token.
\nThis API is responsible of closing the door.\nthe right credential need to be provided.
\nThis API is responsible of Activating the DND (Do Not disturb) feature of the door.\nthe right credential need to be provided.
\nThis API is responsible of Activating the MUR (Make Up Room) feature of the door.\nthe right credential need to be provided.
\nThis API is responsible of Removing the MUR (Make Up Room) feature of the door.\nthe right credential need to be provided.
\nAllow/validate the Skyaccess key token to be performed on the target device.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]},"isInherited":true,"source":{"_postman_id":"a70b6faf-cb42-45ed-82d5-e1eb1b6080b2","id":"a70b6faf-cb42-45ed-82d5-e1eb1b6080b2","name":"SkyAccess Guest - Edition v1","type":"collection"}},"urlObject":{"path":["Person","SK_ValidateAccess","1"],"host":["{{uri}}"],"query":[],"variable":[]}},"response":[{"id":"f3022be3-c416-4568-9e48-44cc2e4714d1","name":"SK_ValidateAccess","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{authorization}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"_DoorID\": 1, \r\n \"_SystemCode\": \"11111114\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{uri}}/Person/SK_ValidateAccess/1"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcQW1hZGVvXDEgLSBTb2Z0d2FyZXNcV2ViIEFwcGxpY2F0aW9uc1wyIC0gV2ViU2VydmljZXNcQW1hZGVvV2ViU2VydmljZXNcUmVzdFdlYkFwaVxhcGlcdjFcUGVyc29uXFNLX1ZhbGlkYXRlQWNjZXNzXDE=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Date","value":"Wed, 09 Jun 2021 15:31:34 GMT"},{"key":"Content-Length","value":"114"}],"cookie":[],"responseTime":null,"body":"{\n \"Error_Code\": 380,\n \"Message\": \"The WirelessTask provided or requested has not been found.\",\n \"Code\": 0,\n \"Response\": null\n}"}],"_postman_id":"c1e72db2-6854-4a3c-9104-27a0923a3408"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"58c33199-9853-43a6-9872-0da7b3b78123","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"181e67d7-eed2-4f46-abdd-69ef5e262a4d","type":"text/javascript","exec":[""]}}]}