RestAPI概述

最新更新:2025-03-18

基本約束

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

數據中心及Base URL

數據中心 Base URL
新加坡 https://ma-api.engagelab.com

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

{base URL}/{API路徑}
          {base URL}/{API路徑}

        
此代碼塊在浮窗中顯示

鑒權方式

EngageLab REST API 採用 HTTP 基本認證 的驗證方式:HTTP Header(頭)里加 Authorization:

Authorization: Basic ${base64_auth_string}
          Authorization: Basic ${base64_auth_string}

        
此代碼塊在浮窗中顯示

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

  • Header 名稱是 "Authorization",值是 base64 轉換過的 "username:password" 對(中間有個冒號)。
  • 在 MA API 的場景里,username 是 APIKey,password 是 APISecret。請在數據來源中添加 API 類型的數據源獲得 APIKey 與 API Secret。
在文档中心打开
icon
聯繫銷售