← 返回

平台集成解决方案接入文档

美洽平台版接入说明

平台版接入的工作主要包含三个部分:

请详询与您联系的美洽商务经理。

签署协议后,负责您平台的美洽商务经理会帮助您获取到美洽平台版的开发账号,内容主要包括:

如果您已近注册了美洽,请直接将超级管理员的登录邮箱交付给美洽商务经理即可,我们会直接在此账号上开通平台版功能。

如果您还没有注册美洽账号,请提供一个用于超级管理员登录的邮箱地址给美洽商务经理,我们会用这个邮箱自动为您生成一个美洽账号。为了保证以后使用过程中账号的安全,请务必提供真实有效的邮箱地址。

美洽的登录地址为:https://app.meiqia.com/signin 。登录验证成功后在地址栏输入 https://app.meiqia.com/platform 进入平台版管理后台。

美洽平台版 API Public Key 和美洽平台版 API Secret Key 主要是用于 API 请求签名和加密,下一部分将详细说明。

一个平台企业在开通美洽平台版后会分配到一个美洽平台版 API Public Key(下面简写为 public_key ) 和一个美洽平台版 API Secret Key(下面简写为 secret_key )。

public_key 在每个请求时都需要带上,作为请求的 HeaderX-App-Key 字段的值。

secret_key 用来为每个请求进行签名,签名的结果作为 HeaderX-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-

目前平台要创建企业只能使用 API 接口。

创建企业的同时,还会同时附带创建此企业的超级管理员账号。

返回的结果在之后很多 API 请求中都会使用到,平台应该将这些内容保存到数据库中,并与平台的企业账号一一对应。

URL: https://eco-api.meiqia.com/platforms/enterprise/new
Method: POST
Content-Type: application/json
字段名 示例值 字段说明
timestamp 1462516126000 当前时间戳
appkey 7f1159891baab483c4a6a7482880xxxx 平台 public_key
fullname 小明的水果店 说要创建的企业名称

返回类型:JSON

字段名 字段说明
ent_id 所创建企业 ID
ent_token 所创建企业识别符
agent_token 所创建企业管理员识别符
email 所创建企业美洽账号

每个企业在创建的时候就已经有了一个超级管理员账号。超级管理员账号可以充当普通客服账号使用,但如果企业客服需求较大,可以增加客服账号。

URL: https://eco-api.meiqia.com/platforms/agent/new
Method: POST
Content-Type: application/json
字段名 示例值 字段说明
timestamp 1462516126000 当前时间戳
appkey 7f1159891baab483c4a6a7482880xxxx 平台 public_key
ent_token 7f1159891baab483c4a6a7482880xxxx 企业识别符
nickname 小明水果店客服 客服昵称

返回类型:JSON

字段名 字段说明
agent_token 所创建客服识别符
email 所创建客服美洽账号

平台通常都有自己的网站模板,将美洽预置到平台模板中可以方便平台旗下企业使用。

美洽网站插件的标准 JS 代码为:

<script type='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 ,如果有需要请访问 美洽文档中心 查阅。