ERP 对接开发说明文档

优质

小牛编辑

115浏览

2023-12-01

一、ERP定义

小能系统提供了灵活的接口，可以将合作网站的ERP页面集成至小能客户端中。如下示意图所示，在每个对话窗口的右侧扩展区域，开放了一个ERP标签，相当于一个浏览器，在该标签下嵌入一个客户按照小能提供的区域尺寸自主开发的动态网页。该动态网页内容不限，可以根据业务需要展示任何客服所需的内容，如客户账号等级信息、客户订单数据、客户物流数据，可以直接嵌入企业内部的CRM数据，也可以嵌入工单输入界面、人工下单界面等。

页面开发完成后提交小能实施顾问页面的URL地址，小能在后台配置后即可出现在坐席客户端中。

156750552955

二、运行原理

1、当用户点击咨询入口的时候，uid、uname或者erpparam等参数传给小能(目前支持 13 个参数，详情请看步骤四、参数说明)

2、小能把信息推送到小能服务器，同时服务器调用指定的erp接口

3、小能服务器访问erp接口，并带上传给小能的参数，接口收到请求，处理，并返回页面

4、小能接收页面，客户端加载并呈现给客服

三、对接步骤及验证

1、网站（web或者wap站点）传参uid、uname根据需求还可以启用参数 erpparam（erpparam可以自定义传参内容）

<!--优先加载基础脚本-->
<script id="xiaonengjs" src="//visitor.ntalker.com/visitor/js/xiaoneng.js?siteid={$siteid}"></script>
<!--通过变量传参-->
<script>
    xn('setCustomerInfo', {     
        uid: '',  //用户ID，用来传递用户登陆ID
        uname: '',//用户名称，用来传递用户名称
        userlevel: '',//用户等级，用来传递用户vip等级
        itemid: '', //商品ID，商品页发起咨询的时候传递商品ID
        orderid: '',  //订单ID，订单提交或支付页传递订单ID
        orderprice: ''//订单金额，传递订单金额
        exterinfo: {
            erpparam: '' //ERP拓展参数，可选，有对接erp需求可用
        }
</script>

2、开发并提供erp接口：

① 小能服务器访问erp接口，要求返回一个页面，内容区大小建议尺寸：380px*770px，该尺寸页面可以完整显示在可视区域内

② 高度加长尺寸：页面长度可以超过建议尺寸770px时，由于超出部分会出现纵向滚动条，挤占页面横向显示区域，页面宽度需调整为340px

③ 宽度加长尺寸：如确实需要页面横向宽度加长，超过350px时，会出现横向滚动条

3、配置erp接口到小能后台设置中，并进行验证

① 登陆后台-设置-接入设置-自定义页签-添加新页签

156750605687

② 根据集成传参，在后台选择对应参数配置完成保存即可

156750597244

4、链接书写规则

1、小能提供以下14个参数：

uid(访客id)、uname(访客的名称)、kfname(客服的登陆账号)、ip(访客的IP地址)、country、province、city(根据访客IP地址解析出的国家、省份、城市)、unionid(unionID机制详见微信公众平台开发者文档)、kfid(客服id)、settingid(接待组id)、sessionid(会话id)、erpparam(erp扩展字段)、devicetype(访客设备来源)、exterinfo(扩展字段)。

2、参数说明：

① IP及地域：仅PC端、wap端访客可以提供IP、country、province、city参数，当无法识别IP所属地域时，country、province、city三个参数有可能为空。当微信对接方案选择【极速对接】、【微信平台授权绑定】时，只能获取country、province、city三个参数；选择【开发模式】时，可能无法获取，此时参数值为空其余终端IP、country、province、city参数值为空。

② unionID：仅微信对接方案选择【微信平台授权绑定】时，unionID才能用于区分多个微信公众账号之间访客的唯一性。

③ devicetype取值说明：0 - PC，1 - 微信，2 - Android App，3 - WAP，4 - iOS SDK，5 - Android SDK，6 - iOS APP，7 - Weibo，8 - 支付宝，9 - 其他。

④ loginid：通过终端集成uid参数透传、kfname：客服的登陆账号、uname：通过终端集成uname参数透传、sessionid：服务端生成的会话ID（唯一）、settingid：咨询会话所在接待组、exterinfo：终端透传参数拓展字段，json对象格式，可自定义多种字段、kfid：服务端生成的客服ID（唯一），用于ntid返回并拉取历史记录

3、参数配置样例

例如：您公司或接口访客id为"userid"，访客名称为"username"。则书写格式为

156750613836

四、ERP测试

① ERP功能要求客户开发ERP接口返回自定义页面，页面显示的内容、样式都由客户基于自身业务场景或使用需求自由定义，最后由小能来加载展示该页面。

② 由于重构支持BS、CS两种架构，CS架构调用电脑设置默认浏览器，BS架构下该页面的运行环境是基于登陆客户端浏览器，可以指定登陆客服使用特定的浏览器，减少H5的兼容性调试。

③ 当该自定义页面无法正常显示时，请联系小能实施对接负责人一起联调。