美洽在線客服平臺版接入說明專業版
平臺版接入的工作主要包含4個部分:
簽署美洽平臺版使用協議
獲取開發賬號
對接美洽平臺版 API
將美洽客服插入到網站模板中
![美洽在線客服平臺版接入說明專業版的圖1]()
簽署美洽平臺版使用協議
請詳詢與您聯系的美洽商務經理。
![美洽在線客服平臺版接入說明專業版的圖3]()
獲取開發賬號
簽署協議后,負責您平臺的美洽商務經理會幫助您獲取到美洽平臺版的開發賬號,內容主要包括:
美洽賬號
美洽平臺版 API Public Key
美洽平臺版 API Secret Key
如果您已經注冊了美洽,請直接將超級管理員的登錄郵箱交付給美洽商務經理即可,我們會直接在此賬號上開通平臺版功能。
如果您還沒有注冊美洽賬號,請提供一個用于超級管理員登錄的郵箱地址給美洽商務經理,我們會用這個郵箱自動為您生成一個美洽賬號。為了保證以后使用過程中賬號的安全,請務必提供真實有效的郵箱地址。
美洽的登錄地址為:https://app.meiqia.com/signin 。
登錄驗證成功后在地址欄輸入 https://app.meiqia.com/platform 進入平臺版管理后臺。
美洽平臺版 API Public Key 和美洽平臺版 API Secret Key 主要是用于 API 請求簽名和加密,下一部分將詳細說明。
直接進入美洽開發文檔頁面地址:https://meiqia.com/help/development
![美洽在線客服平臺版接入說明專業版的圖5]()
對接美洽平臺版 API
美洽 API 使用方法
一個平臺企業在開通美洽平臺版后會分配到一個美洽平臺版 API Public Key(下面簡寫為 public_key ) 和一個美洽平臺版 API Secret Key(下面簡寫為 secret_key )。
public_key 在每個請求時都需要帶上,作為請求的 Header 中 X-App-Key 字段的值。
secret_key 用來為每個請求進行簽名,簽名的結果作為 Header 中 X-Message-Digest 字段的值。簽名算法使用 HMAC-SHA1 算法,secret_key 為 HMAC 密鑰。
下面是個偽代碼的個例子:
// 構造 API 請求
api_params = {
‘timestamp’: timestamp,
‘fullname’: fullname,
‘appkey’: appkey
}
// 為了進行 HMAC 計算,將 API 請求轉化為字符串
// 本段輸出結果為一個字符串:
// api_params_str = '{“timestamp”: timestamp,“fullname”:
fullname,“appkey”: appkey}'api_params_str = json.dumps(params)
// 使用secret_key 對 api_params_str 進行 HMAC 計算請求簽名
// 本段輸出結果為一個 40 位長的字符串:
//sig = ‘8201860acfbce7fb2cb552a62baadbe8fbxxxxxx’
sig =HMAC(api_params_str, secret_key,sha1)
// 將 appkey 和請求加密簽名放到請求頭部
headers = ({‘X-Message-Digest’: sig,
‘X-App-Key’: appkey})
// 最終構造的請求為
response = post_json(url,api_params, headers=headers)
// -EOF-
![美洽在線客服平臺版接入說明專業版的圖7]()
API : 創建平臺旗下企業
說明
目前平臺要創建企業只能使用 API 接口。
創建企業的同時,還會同時附帶創建此企業的超級管理員賬號。
返回的結果在之后很多 API 請求中都會使用到,平臺應該將這些內容保存到數據庫中,并與平臺的企業賬號一一對應。
請求地址與方法
URL: https://eco-api.meiqia.com/platforms/enterprise/new
Method:POST
Content-Type: application/json
請求參數

返回結果
返回類型:JSON

![美洽在線客服平臺版接入說明專業版的圖11]()
API : 為平臺旗下企業添加客服賬號
說明
每個企業在創建的時候就已經有了一個超級管理員賬號。超級管理員賬號可以充當普通客服賬號使用,但如果企業客服需求較大,可以增加客服賬號。
請求地址與方法
URL: https://eco-api.meiqia.com/platforms/agent/newMethod:
POSTContent-Type: application/json
請求參數
返回結果
返回類型:JSON

![美洽在線客服平臺版接入說明專業版的圖15]()
將美洽插件插入到網站模板
平臺通常都有自己的網站模板,將美洽預置到平臺模板中可以方便平臺旗下企業使用。
美洽網站插件的標準 JS 代碼為:
<scripttype=‘text/javascript’>
(function(m, ei, q, i, a, j, s) { m[a] = m[a] || function() {
(m[a].a = m[a].a || []).push(arguments)
};
j = ei.createElement(q),
s = ei.getElementsByTagName(q)[0];
j.async = true;
j.charset = ‘UTF-8’;
j.src = i + ‘?v=’ + new Date().getUTCDate(); s.parentNode.insertBefore(j, s); })(window, document, ‘script’,
‘//static.meiqia.com/dist/meiqia.js’, ‘_MEIQIA’); _MEIQIA(‘entId’,
#####); // 這里 ##### 代表企業的 ent_id
/script>
平臺將此段 JS 代碼插入到平臺網站模板中即可為平臺下企業開啟客服功能。
需要提示的是,每個企業的 ent_id 都不相同,所以企業需要將模板中的這部分作為變量處理。
此段代碼使用了異步加載的方式,所以不用擔心阻塞網站代碼的加載。美洽網站插件還提供了很多方便開發者自定義的 API ,如果有需要請訪問 美洽文檔中心 查閱。
工程師必備
- 項目客服
- 培訓客服
- 平臺客服
TOP




















