邊緣端OpenAPI對外提供服務的端口號為9999。為保證傳輸安全，所有接口僅支持HTTPS協議。

認證授權

目前支持通過Cookie認證方式訪問OpenAPI。開發者必須通過CreateAuthCookie接口獲取認證Cookie才能進一步調用其它API。具體步驟如下所示。

1. 通過訪問如下地址，登錄邊緣網關控制臺，配置API訪問權限。

   https://{ip}:9999

   其中，{ip}為網關所在機器的IP地址。

   說明 登錄邊緣網關控制臺相關操作，請參見登錄邊緣網關控制臺。
2. 調用CreateAuthCookie接口創建認證Cookie。
   CreateAuthCookie接口采用Basic Authentication認證方式，即通過HTTP請求頭部Authorization字段傳遞認證標識。

   Authorization字段格式如下所示。

   Authorization: Basic <base64(username:password)>

   其中，base64(username:password)是<登錄邊緣網關控制臺的用戶名:密碼>的Base64編碼字符串。

   例如，登錄邊緣網關控制臺的用戶名為admin，密碼為admin1234，則Authorization字段內容如下所示。

   Authorization: Basic YWRtaW46YWRtaW4xMjM0

3. 從CreateAuthCookie接口的HTTP響應頭中，獲取Set-Cookie參數的值。
   Set-Cookie字段格式如下所示。

   Set-Cookie: token=d71020ad5cb58faf04a6fd81d6df9680582b987eb6d0ce7b33bc3a3e4f******; Max-Age=3600; Path=/

4. 將CreateAuthCookie接口響應頭的Set-Cookie參數值，當做其它API HTTP請求頭的Cookie參數值。
   HTTP請求頭的Cookie參數格式如下所示。

   Cookie: token=d71020ad5cb58faf04a6fd81d6df9680582b987eb6d0ce7b33bc3a3e4f******; Max-Age=3600; Path=/

5. 調用除CreateAuthCookie之外的其它OpenAPI時，通過HTTP請求頭的Cookie字段傳遞認證標識Token，Link IoT Edge會驗證該認證標識Token是否具有對應API的訪問權限。

響應規范

• 狀態碼：響應狀態碼遵循HTTP規范。詳細狀態碼，請參見狀態碼。
• 響應頭：響應頭需要包含如下字段默認值。

  Server: openresty/1.13.6.2
  Date: Thu, 31 Oct 2019 07:51:57 GMT
  Content-Type: application/json; charset=utf-8
  Transfer-Encoding: chunked
  Connection: keep-alive

• 響應消息體：響應消息體為JSON格式內容，或者為空。
  • 當調用API成功時，每個API返回的格式和內容都不同，詳情請參見具體API接口文檔。
  • 當調用API出錯時，即響應狀態碼為非2**開頭的狀態碼（例如302、400等），響應消息體為錯誤信息內容，格式如下所示。

    {
      "Code": "string", // What kind of error, such as InvalidParameter.
      "Message": "string" // Detailed description about the error.
    }