\r\n The ENVOY provides a web service for managing all the services and operations running on the ENVOY.\r\n\r\n This document describes the EWI (Envoy Web Service Interface) used for advanced integration with the ENVOY; the EWI and related interactions described by this document define the externally-visible (black box view) perspective of the services provided by the ENVOY. It is the intent of this specification and interface architecture to shield you from the details of the operations within the ENVOY.\r\n
\r\n\r\n The Protocol used to communicate between the ENVOY and other applications is based on REST (Representational State Transfer) over HTTP.\r\n\r\n The REST API provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. REST API operate over HTTP making it easy to use with any programming language or framework.\r\n
\r\nBy default the REST API port operates on: 80
\r\n\r\n Username: envoy
\r\n Password: envoy
\r\n
sha256 ([Password] + SALT)
\r\nprivate static String hashMessage(String message) throws NoSuchAlgorithmException {\r\n MessageDigest md = MessageDigest.getInstance("SHA-256");\r\n md.reset();\r\n byte[] buffer = message.getBytes();\r\n md.update(buffer);\r\n byte[] digest = md.digest();\r\n\r\n String hexStr = "";\r\n for (byte aDigest : digest) {\r\n hexStr += Integer.toString((aDigest & 0xff) + 0x100, 16).substring(1);\r\n }\r\n return hexStr;\r\n} \r\nprivate static String makeSecret(String key) throws NoSuchAlgorithmException {\r\n final String salt = "QGFjdGl2ZQ==";\r\n return hashMessage(key + salt);\r\n}\r\n//This will be the secret key\r\nfinal String secretKey = makeSecret("envoy");\r\n \r\n \r\ncurl -D- -u envoy:d4de3dbdb2cff44f39741a6f8adbba74feccdc7cc02d1bb6ed27b37354687c25 -X \r\nGET -H "Content-Type: application/json"\r\nhttp://{{host}}:{{port}}/ALE/api/logical-device?fields=name\r\n \r\n \r\ncurl –D- -X GET -H "Authorization: Basic {Base64 Encoded String}" -H \r\n"Content-Type: application/json" http://{{host}}:{{port}}/ALE/api/ping\r\n \r\n e.g:
curl –D- -X GET -H "Authorization: Basic ZW52b3k6ZDRkZTNkYmRiMmNmZjQ0ZjM5NzQxYTZmOGFkYmJhNzRmZWNjZGM3Y2MwMmQxYmI2ZWQyN2IzNzM1NDY4N2MyNQ== " \r\n-H "Content-Type: application/json" http://{{host}}:{{port}}/ALE/\r\n \r\n {\r\n "username":"envoy",\r\n "password":"d4de3dbdb2cff44f39741a6f8adbba74feccdc7cc02d1bb6ed27b37354687c25 "\r\n}\r\n\r\n//Cookie holder\r\nprivate static String cookie;\r\nprivate static void authenticate() throws IOException, NoSuchAlgorithmException {\r\n final String secretKey = makeSecret("envoy");\r\n final byte[] rawData = ("{\\n" +\r\n "\\t\\"username\\":\\"envoy\\",\\n" +\r\n "\\t\\"password\\":\\"" + secretKey + "\\"\\n" +\r\n "}").getBytes(StandardCharsets.UTF_8);\r\n\r\n\r\n //Set connection properties\r\n HttpURLConnection conn = (HttpURLConnection) new URL("http://{{host}}:{{port}}/ALE/api/auth").openConnection();\r\n conn.setDoOutput(true);\r\n conn.setRequestMethod("POST");\r\n conn.setRequestProperty("Content-Type", "application/json");\r\n conn.setRequestProperty("Content-Length", String.valueOf(rawData.length));\r\n //Write body\r\n try (OutputStream os = conn.getOutputStream()) {\r\n os.write(rawData);\r\n os.flush();\r\n }\r\n //Connect and publish data\r\n conn.connect();\r\n\r\n final int responseCode = conn.getResponseCode();\r\n\r\n if (responseCode == HTTP_OK) {\r\n //Authentication successful\r\n final String headerField = conn.getHeaderField("Set-Cookie");\r\n if (headerField != null) {\r\n //A cookie was received\r\n cookie = headerField;\r\n }\r\n } else {\r\n //TODO: Handle error\r\n }\r\n}\r\npublic static void main(String[] args) throws IOException, NoSuchAlgorithmException {\r\n //Check if the user was authenticated">\r\n //Authenticate the user\r\n authenticate();\r\n if (cookie == null) {\r\n //The user is not authenticated\r\n System.err.println("User not authenticated");\r\n return;\r\n }\r\n \r\n //Set connection properties\r\n //Request example to test authentication\r\n HttpURLConnection newConn = (HttpURLConnection) new URL("http://{{host}}:{{port}}/ALE/api/activity?fields=name").openConnection();\r\n newConn.setRequestProperty("Cookie", cookie);\r\n newConn.setDoOutput(true);\r\n newConn.setRequestMethod("GET");\r\n\r\n //Connect and publish data\r\n newConn.connect();\r\n final int responseCode = newConn.getResponseCode();\r\n\r\n //Read the response body (If any)\r\n StringBuilder body = new StringBuilder("");\r\n try (BufferedReader inputStream = new BufferedReader(new InputStreamReader(newConn.getInputStream()))) {\r\n String line = null;\r\n while ((line = inputStream.readLine()) != null) {\r\n body.append(line);\r\n }\r\n }\r\n if (responseCode == HTTP_OK) {\r\n //TODO: Do stuff here\r\n\r\n //Print the data received\r\n System.out.println(body.toString());\r\n } else {\r\n //TODO: Handle error\r\n System.err.println(body.toString());\r\n }\r\n}\r\n\r\n