REST API 概述

基本約束

• API 被設計為符合 HTTP、 REST 規範。例如：查詢請求使用 GET 方法，提交請求使用 POST 方法。如果一個請求不是相應的 HTTP 方法，將返回錯誤。
• 如無特殊說明，調用參數值應轉碼為：UTF-8， URL 編碼。

數據中心及 Base URL

當使用 REST API 時，需要將選定的 base URL 與具體 API 的路徑結合起來獲得完整的調用地址。

              
              {base URL}/{API路徑}

            

鑑權方式

EngageLab REST API 採用 HTTP 基本認證 的驗證方式：HTTP Header（頭）裡加 Authorization：

              
              Authorization: Basic ${base64_auth_string}

            

上述 base64_auth_string 的生成算法為：base64(api_key:api_secret)

• Header 名稱是 "Authorization"，值是 base64 轉換過的 "username:password" 對（中間有個冒號）。
• 在 LiveDesk API 的場景裡，username 是 API Key，password 是 API Secret。請在「項目設置-API 管理」中添加 API 類型的數據源獲得 API Key 與 API Secret。