售后宝帮助中心

Appearance

在此页面上

一、什么是系统集成 ​

  • 系统集成中心是售后宝与外部系统进行数据交互的唯一通道。通过集成中心，三方应用可以取得售后宝OpenAPI的秘钥，从而获取系统内各类业务数据；集成中心提供预设的组件，开发者可以通过可视化的配置流程编排API，快速创建自定义的集成逻辑，实现售后宝与其他系统间的数据传输。

image.png

二、集成方式 ​

  • 售后宝集成中心致力于用更少的开发，实现更广泛的系统集成，支持通过推送、同步、传入、导出等多种灵活的集成方式，帮企业实现数据互联，避免数据孤岛。
  • 被动集成：
    • 当外部系统需要1.获取售后宝内的数据或 2.向售后宝传输数据时，需通过调用售后宝已开放的OpenAPI实现，用户只需在集成中心完成注册，即可获得接口秘钥。
    • 目前售后宝已开放超100+接口，且还在不断迭代。接口文档：https://www.yuque.com/shb/api/dyn90l?#Ob1Do也支持客户按需定制接口。
    • 开发者需要自主编码调用售后宝开放的API，并根据自己的需求定制开发实现深度的系统集成；
  • 主动推送：
    • 当售后宝内发生某个事件时，需要主动向外部系统传输数据时，可在「集成中心」配置外部应用的规定参数、注册API信息、通过「触发器」配置触发事件，可快速实现集成。
    • 售后宝已实现与数十款业内常用软件的常用接口集成，用户仅需一键启用，免去开发的成本。除触发器外，OpenAPI内也支持工单、备件、客户、产品、事件五个模块的主动推送服务。

三、各版本、端口的区别及说明 ​

1. 版本说明 ​

标准版企业版智能版国际版
三方应用集成
（支持主动推送）无✅✅与企业版仅语言不同
OpenAPI✅✅✅与企业版仅语言不同

2. 端口说明 ​

钉钉端独立端企微端飞书端
全部功能✅✅✅✅

四、使用场景 ​

1）A企业的客户信息统一维护在纷享销客中，在新增客户或者客户信息有变更时，无法直接同步到售后宝中，时间一长，售后宝的客户模块信息不准确，售后服务效率降低 2）B企业的库存管理系统用的是金蝶云星空，但是流程管理用的是售后宝的工单。通常工单中有所需物料时，还需要去更新金蝶云库存，费时费力 3）C企业的产品质保要从安装完成开始计算，因此需要根据安装工单的完成时间去「产品管理」变更产品的质保开始时间。当工单量较大时，产品质保信息若未及时更新会影响到后续售后服务结算 4）A企业主营净水器业务，他们会记录每台销售产品滤芯的到期日期，并且需要在滤芯到期前3天，每天短信提醒客户，同时每天系统通知客服关怀提醒客户更换滤芯。

五、功能位置 ​

image.png

六、功能使用说明 ​

6.1 操作入口 ​

  • 入口：系统管理-应用设置-系统集成
  • 权限：有「系统配置」权限的账号可访问

6.2 集成列表 ​

6.2.1 已集成的应用 ​

用户可以在「已集成应用」列表查询已经实现集成的应用信息，包括集成方式、集成状态，调用日志等，用户可以在此页面操作启用/禁用、删除系统集成应用。image.png

6.2.2 三方应用市场 ​

该页面为售后宝已内置集成的三方应用列表，该列表中的应用只需用户点击安装，并配置响应的鉴权参数即可开启使用。如您想集成更多应用，请联系我们。

6.3 创建集成应用（第一步） ​

6.3.1 从新建入口创建 ​

单击新建按钮，出现新建集成应用页面，填写应用名称，上传logo（如不上传默认展示应用名称前2个字），应用描述，集成方式（集成方式新建后不可更改），点击去配置。

关于集成方式：

  • 配置集成：表示售后宝主动调用外部应用接口，主动抓取/推送数据给外部应用；
  • 开发集成：表示外部应用调用售后宝开放平台接口，抓取售后宝系统的数据；

image.png

6.3.1.1 设置鉴权 ​
  • 目前售后宝主动调用外部应用接口支持标准的token鉴权方式，用户可自行配置鉴权参数调用，售后宝将使用用户配置的参数调用接口。如需支持其他的鉴权方式（如接口签名，参数加密），请联系我们。
配置鉴权字段 ​
  • 在此处需配置调用获取Token接口的传参，如appKey\appSecret、clientId\clientSecret，如下图是需要username，paasword参数的传参配置，配置好后填写下一步。

配置Token请求接口 ​
  • 用户可根据实际情况选择请求Token接口的请求方式，并可配置参数传输的位置：Params（参数传在链接上），Headers（参数放在请求头上），Body（参数放在请求体里，仅POST支持）

配置Token的有效期，请按照真实的Token有效期填写，超出有效期的时候，售后宝会自动调用获取Token接口获取新的Token。 配置鉴权账号，可根据实际情况配置多个账号，并选择一个账户进行操作。 选择好账户后，可点击调试按钮调试鉴权接口，如果调用正常，会返回接口的响应参数。 如果有报错，请检查接口参数配置是否正确！

设置调用接口的Token传输方式 ​
  • 配置鉴权字段携带的方式，使用$.xxx.xxx获取Token字段在获取Token接口的反参的位置

根据实际情况配置好参数

鉴权调试 ​

填写实际可调用的接口路径及请求方式，配置必要的传参，点击鉴权调试，如果配置一切正常，返回结果中会打印接口的实际返参。

6.3.2 应用市场安装集成 ​

在"系统集成"页面，点击"三方应用市场"，找到需要集成的应用，点击安装，确认，即完成三方集成应用的安装。

6.3.2.1 市场应用设置鉴权 ​

完成安装后，系统会跳转到参数配置页面，用户可在此处配置鉴权必需的参数值。 填写完参数后，点击鉴权调试，如果提示鉴权成功并打印了接口返回的参数，则代表鉴权成功，可进行接口的调用了。反之，请检查参数填写是否正确，如有疑问可联系我们。

6.4 配置API接口（第二步） ​

6.4.1 配置分类 ​

API接口支持配置分类，用户可新建分类，并在分类下建API接口。 每个分类下可以建二级分类，API也可以在二级分类下

6.4.2 配置API ​

在分类下，可新建对应模块的API 新建API-填写API的基本信息，并选择API的类型

关于API类型： 选择类型：可作为触发器起始节点，主动进行触发操作 删除/修改/新建类型：可作为触发器的执行节点，被动执行触发器的执行操作

配置API的请求方式（目前支持GET、POST、PATCH、DELETE），请根据接口实际情况进行配置，并填写API的请求地址。 配置API的请求参数（request），POST、PATCH、DELETE支持Params传参、header传参、body传参，body传参支持JSON格式（content-type = application/json）和form表单（content-type = application/x-www-form-urlencoded），GET仅支持Params传参和header传参。 配置API的返回参数（response），response仅支持JSON格式（content-type = application/json），可在页面编写JSON格式 如果JSON很复杂，也可使用导入JSON工具快速导入JSON结构 导入JSON格式后，检查导入的格式是否有误，并填写参数的备注信息 配置API调用成功的条件，该条件是判断API是否调用成功的依据，必需按实际情况填写 点击完成即可创建新API

6.5 配置触发器调用集成API（第三步） ​

系统可以通过触发器配置出主动推送的事件，当售后宝系统的业务模块中触发了该事件，就可以通过集成中心建立与外部应用的联系，实现数据的传输。触发器的配置入口有详细的配置手册见：触发器能力

6.5.1 触发器入口 ​

  • 入口1：智能机器人分组-智能触发器
  • 权限：有「查看触发器」权限的账号才能访问该菜单；

  • 入口2：系统设置-应用设置-智能触发器
  • 权限：有「系统设置」权限的账号才能访问该入口；

  • 集成应用-配置集成-触发器

6.5.2 配置触发器 ​

6.5.1.1 集成应用作为触发应用 ​

点击新建触发器，输入名称和描述后下一步 点击选择触发应用，选择外部应用-对应应用-一级分类-（二级分类）-API 配置触发方式，外部应用仅支持webhook触发和定时触发，按需要配置即可。

webhook触发：调用webhook链接，传入对应的参数即可调用触发器 定时触发：按照定时配置，使用定时调用的参数调用触发器

点击"+"号，配置执行应用，可触发执行事件/消息通知 选择执行应用，这里以新建客户-新建产品-新建工单的配置为例

  • 首先新建客户：

  • 然后新建产品：

  • 再新建工单：

  • 触发器详情，用户可根据实际情况配置流程条件，判断是否继续执行节点操作

6.5.1.2 集成应用作为执行应用 ​

点击新建触发器，输入名称和描述后下一步 点击选择触发应用，选择内部应用-对应应用-对应表单-查询数据 配置触发方式，内部应用支持事件触发、超时触发、webhook触发和定时触发，按需要配置即可。

事件触发：当表单发生某个事件（新建/流程提交/...），自动触发调用触发器 超时触发：当表单某2个节点时间超过配置的时间时（目前仅支持工单、事件、PaaS流程表单），自动触发调用触发器 webhook触发：调用webhook链接，传入对应的参数即可调用触发器 定时触发：按照定时配置，使用定时调用的参数调用触发器

内部应用的事件触发，可配置多个节点触发 点击"+"号，配置执行应用，可触发执行事件/消息通知 选择执行应用，这里以 新建工单-->调用集成新增接口-->反写接口返回的编号和id 的配置为例

  • 选择执行应用下的接口，触发器执行节点仅支持选择新增/修改/删除类型的API

  • 选择API入参参数取值

  • 配置反写节点

  • 反写需要确定原始单据，这里的编辑条件可以选择工单编号 对应等于 第一个节点的工单编号

  • 触发器详情，用户可根据实际情况配置流程条件，判断是否继续执行节点操作

6.5.3 执行调用触发器 ​

6.5.3.1 集成应用API作为起始节点 ​

集成应用作为起始节点，目前仅支持webhook触发和定时触发。

  • 以webhook触发为例：

进入触发器详情，点击触发应用，选择触发条件为webhook触发，复制webhhok地址，并指定接口传参调用。已使用接口调用工具为例： CRUL：

curl --location --request POST 'https://cloud.shb.ltd/api/application/outside/trigger/instance/webhook/LDDAaMAGaqwtuXiJTYkVtNqqkDALHwotkmFLgZWsDuZs6sg92hbyJj6uL35Uo7khqVrwFoHroqn5Twk' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Host: cloud.shb.ltd' \
--header 'Connection: keep-alive' \
--data '{
    "id": "1"
}'

6.5.3.2 集成应用API作为执行节点 ​

集成应用作为执行节点，支持的触发方式以触发节点选择的应用为准。

若触发应用为外部应用，目前仅支持webhook触发和定时触发。 若触发应用为内部应用，支持事件触发、超时触发、webhook触发和定时触发。

以内部应用事件触发为例：打开触发器，点击触发应用，当前触发器配置的是工单新建触发。 新建工单-填写对应的客户、产品数据-点击保存 保存后，触发器立即执行调用集成应用，以本触发器为例，会把API接口返回的字段数据反写到工单数据上，刷新工单详情，可以看到工单字段上已完成字段反写，表明已完成触发器调用。 查看接口调用日志 系统集成列表-已集成应用-日志

6.6 配置开发集成参数（OpenAPI） ​

在集成列表中点击对应应用的设置按钮，进入应用设置页面，点击"开发集成"tab切换至开发集成的配置页面。 如果是第一次安装配置，此页面为空，点击生成按钮，即可生成外部应用调用售后宝的鉴权参数。 点击任一生成按钮生产key和密钥，默认操作人为当前操作用户，用户需配置调用方的ip至白名单，如果调用ip不在白名单，则不允许调用。 售后宝接口文档可参考：https://www.yuque.com/docs/share/28839dcf-9c2c-4bec-8d52-d3f54e4187fc?# 《售后宝开放API文档V2.8-Beta》

6.7 查看接口调用日志 ​

系统集成列表-已集成应用-日志 日志页面分为4个tab，发起应用调用和执行应用调用为触发器调用集成接口API的日志，被动调用和主动调用为开发集成中的调用日志。

七、主要应用场景内集成中心触发器（主动推送事件）配置 ​

场景1:外部系统——>售后宝 ​

image.png

场景2:售后宝——>外部系统 ​

image.png

场景3:售后宝——>售后宝 ​

image.png