This is documentation of an API that allows interacting with Aladdin Genie Connect garage door controllers.
\nThis API was reverse engineered from the Aladdin Connect Android app.
\nThis is not the full API documentation but does provide enough details on how to:
\nGet an authorization token to be used for all other API requests.
\nYou will need to generate a loginToken from the username and password and use this value in the Authorization header in place of {loginToken}
\nTo generate the loginToken use the credentials in the form of \"{userName}:{password}\" and convert this value to Base64.\ne.g, for credentials
\nthis becomes \"user@test.com:12345\" converting this string to Base64 gives a loginToken of \"dXNlckB0ZXN0LmNvbToxMjM0NQ==\" (do not include the quotes in the header value)
\nThe response of this request (assuming valid credentials are used) is the authorization token which should be use in place of {authToken} in the Authorization header in all other API requests.
\n","urlObject":{"protocol":"https","path":["api","portals","v1","users","_this","token"],"host":["genie","exosite","com"],"query":[],"variable":[]}},"response":[{"id":"a5a8fefc-e04a-4e34-b5fb-ccfb5e694363","name":"Valid Login","originalRequest":{"method":"GET","header":[{"key":"AppVersion","value":"2.10.1"},{"key":"BundleName","value":"com.geniecompany.AladdinConnect"},{"key":"User-Agent","value":"Aladdin Connect Android v2.10.1'"},{"key":"BuildVersion","value":"131"},{"key":"Authorization","value":"Basic dXNlckB0ZXN0LmNvbToxMjM0NQ=="}],"url":"https://genie.exosite.com/api/portals/v1/users/_this/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Tue, 13 Nov 2018 01:31:35 GMT"},{"key":"Server","value":"Apache"},{"key":"Status","value":"200 OK"},{"key":"Content-Length","value":"94"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\"exampleAuthToken\""},{"id":"f53337c0-2283-4c71-88d5-95c933ad3da0","name":"Login - Invalid Credentials","originalRequest":{"method":"GET","header":[{"key":"AppVersion","value":"2.10.1"},{"key":"BundleName","value":"com.geniecompany.AladdinConnect"},{"key":"User-Agent","value":"Aladdin Connect Android v2.10.1'"},{"key":"BuildVersion","value":"131"},{"key":"Authorization","value":"Basic dXNlckB0ZXN0LmNvbToxMjM0NQ=="}],"url":"https://genie.exosite.com/api/portals/v1/users/_this/token"},"status":"Forbidden","code":403,"_postman_previewlanguage":"html","header":[{"key":"Content-Type","value":"text/html"},{"key":"Date","value":"Tue, 13 Nov 2018 02:45:59 GMT"},{"key":"Server","value":"Apache"},{"key":"WWW-Authenticate","value":"Basic realm=\"Portals API\""},{"key":"Content-Length","value":"9"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"Forbidden"}],"_postman_id":"6c079051-c3d5-73c8-1328-de8692af60f4"},{"name":"User Info","id":"ad753f36-50f7-4321-b0e2-bf08b5fe5b10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"AppVersion","value":"2.10.1","type":"text"},{"key":"BundleName","value":"com.geniecompany.AladdinConnect","type":"text"},{"key":"User-Agent","value":"Aladdin Connect Android v2.10.1'","type":"text"},{"key":"BuildVersion","value":"131","type":"text"},{"key":"Authorization","value":"Token: {authToken}","type":"text"}],"url":"https://genie.exosite.com/api/portals/v1/users/_this","description":"Request user details - this is needed to get the user ID which will be needed for other API requests
\n","urlObject":{"protocol":"https","path":["api","portals","v1","users","_this"],"host":["genie","exosite","com"],"query":[],"variable":[]}},"response":[{"id":"a06d0bab-25e8-49ee-8b95-9c18a506e1f0","name":"User Info","originalRequest":{"method":"GET","header":[{"key":"AppVersion","value":"2.10.1","type":"text"},{"key":"BundleName","value":"com.geniecompany.AladdinConnect","type":"text"},{"key":"User-Agent","value":"Aladdin Connect Android v2.10.1'","type":"text"},{"key":"BuildVersion","value":"131","type":"text"},{"key":"Authorization","value":"Token: exampleAuthToken","type":"text"}],"url":"https://genie.exosite.com/api/portals/v1/users/_this"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Tue, 13 Nov 2018 01:40:43 GMT"},{"key":"Server","value":"Apache"},{"key":"Status","value":"200 OK"},{"key":"Content-Length","value":"507"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"email\": \"user@test.com\",\n \"fullName\": \"Example User\",\n \"id\": \"9999999999\",\n \"rid\": \"blahblahblabh\",\n \"meta\": {\n \"acceptTerms\": true,\n \"securityQuestion\": 1,\n \"securityAnswer\": \"Security Question Answer\"\n },\n \"phoneNumber\": \"\",\n \"userName\": \"user@test.com\",\n \"activated\": true,\n \"groups\": [],\n \"permissions\": [\n ]\n}"}],"_postman_id":"ad753f36-50f7-4321-b0e2-bf08b5fe5b10"},{"name":"User Portals","id":"e9047ade-6531-4016-b35f-d6ce3a627805","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"AppVersion","type":"text","value":"2.10.1"},{"key":"BundleName","type":"text","value":"com.geniecompany.AladdinConnect"},{"key":"User-Agent","type":"text","value":"Aladdin Connect Android v2.10.1'"},{"key":"BuildVersion","type":"text","value":"131"},{"key":"Authorization","type":"text","value":"Token: {authToken}"}],"url":"https://genie.exosite.com/api/portals/v1/users/{user_id}/portals","description":"Retrieve portals for the user - again, this request is just needed to get the PortalID which is needed for other API requests
\nReplace {user_id} in the URL with the id retrieved from the User Info request.
Returns an array of \"portals\" I'm not sure what exactly a portal represents or if a user ever has more than 1.
\n","urlObject":{"protocol":"https","path":["api","portals","v1","users","{user_id}","portals"],"host":["genie","exosite","com"],"query":[],"variable":[]}},"response":[{"id":"63643f48-6e4e-4d3c-9a7b-973ebe9d6671","name":"User Portals","originalRequest":{"method":"GET","header":[{"key":"AppVersion","value":"2.10.1","type":"text"},{"key":"BundleName","value":"com.geniecompany.AladdinConnect","type":"text"},{"key":"User-Agent","value":"Aladdin Connect Android v2.10.1'","type":"text"},{"key":"BuildVersion","value":"131","type":"text"},{"key":"Authorization","value":"Token: exampleAuthToken","type":"text"}],"url":"https://genie.exosite.com/api/portals/v1/users/9999999999/portals"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Date","value":"Tue, 13 Nov 2018 01:46:26 GMT"},{"key":"Server","value":"Apache"},{"key":"Status","value":"200 OK"},{"key":"Content-Length","value":"290"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"PortalName\": \"PortalName\",\n \"PortalID\": \"8888888888\",\n \"PortalRID\": \"SomeGuidValue\",\n \"UserEmail\": \"user@test.com\",\n \"Description\": \"Description\",\n \"Permissions\": [\n {\n \"access\": \"___admin\"\n }\n ]\n }\n]"}],"_postman_id":"e9047ade-6531-4016-b35f-d6ce3a627805"},{"name":"Portal Details","id":"b2f70945-b06f-482b-9215-449602027c81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"AppVersion","value":"2.10.1","type":"text"},{"key":"BundleName","value":"com.geniecompany.AladdinConnect","type":"text"},{"key":"User-Agent","value":"Aladdin Connect Android v2.10.1'","type":"text"},{"key":"BuildVersion","value":"131","type":"text"},{"key":"Authorization","value":"Token: {authToken}","type":"text"}],"url":"https://genie.exosite.com/api/portals/v1/portals/{portal_id}","description":"Retrieve details for a specific portal.
\nReplace {portal_id} in the URL with the PortalID value from the User Portals request
The important info returned here is the list of device Ids in the devices array and the portal key located at info.key. Both of these values will be needed to retrieve or set door state.
RPC call to retrieve door info for a device.
\nEach device can control up to 3 doors. This request is setup to retrieve the door status, name, and link status for all 3 doors.
\nIn the auth property. cik is the portal key and client_id is the device id, both of these values are retrieved from the Portal Details request.
The calls array can contain any number of properties you want to retrieve details on. In this example I'm getting the door_status, name, and link_status for all 3 doors, dps1, dps2, dps3.
Possible Door Status return values are:
\nPossible Link Status return values are:
\nRPC call to set door state for a device.
\nauth values should be set the same as the Get Door Info request example.
Desired status and desired status user should be set together.
\nThis example is a request to close door 1 on the device - dps1
Possible Desired Status values
\n