功能概述 ​

售后宝开放API提供系统集成的能力，企业可以通过API实现其他系统与售后宝的集成，将其他系统的数据导入到售后宝中，其他系统也可以通过API获取售后宝中的数据。API接口将采取逐步开放的方式提供给需要的企业，V2.0版本支持事件、工单、客户、产品、备件的部分开放接口，后续将逐步开放更多的接口。

开始接入 ​

为保证企业信息安全，用户在调用售后宝API前需提交申请，提供必要的企业信息。 申请通过后用户可创建应用调用售后宝开放API接口。 获取开放API权限后在系统管理中会出现开放API选项，API设置都可以在这里查看和操作。 使用API需要在系统中创建API应用：系统设置->应用管理中可以查看所有的API应用，每个企业最多可以拥有5个应用。 应用的应用Key、应用密钥和IP白名单用于获取API授权，操作负责人用于追踪日志。

1.进入售后宝系统，点击系统设置->应用管理，可以进入应用列表界面 ​

2.在应用列表界面，可以看到所有应用的简要信息，可以新建应用，以及对每个应用进行删除和设置，点击设置可以看到应用的详情信息，也可以全局开启主动推送的能力 ​

3.点击创建应用，在弹出框填入正确的数据可以创建出一个新应用，一个企业最多新建五个应用 ​

4.点击设置可以看到应用的详情信息，在此界面可以进行应用的修改、重置秘钥、设置IP、更改操作负责人、设置数据推送、失败预警等操作 ​

权限模块 ​

获取应用令牌Token ​

用于获取应用授权令牌（access_token），使用任何API都需要一个授权令牌 每次获取令牌都会有失效日期（2小时后），因此每次使用获取的令牌都要先判断是否过期（例如差10分钟过期，或者已经过期），当发现令牌即将过期时需要从新申请令牌，申请令牌时方法需要加锁，防止并发时多个请求同时更新令牌。 每个应用每天限制获取令牌50次，因此每次获取令牌后需要保存到本地，在令牌有效期内可重复使用。

接口安全限制 ​

为保证OpenAPI服务稳定运行，系统对API接口的调用进行了频率和次数的限制，限制内容如下，具体接口见开发文档：

1.应用限制 ​

系统限制每个企业可以在系统中获取5个OpenAPI应用，但每个应用的使用次数和时长不限。

2.获取Token限制 ​

系统限制企业每个应用每24小时可以调用接口获取 Token 50次，时间限制从调用第一次接口开始计算。 获取到的每个Token的有效期为2个小时，失效后需要重新获取

3.接口调用频率限制 ​

除系统类接口之外，其余各模块的接口每个OpenAPI应用限定调用接口频率为：每秒最多调用2次接口

4.接口调用次数限制 ​

除系统类接口之外，其余各模块的新建、编辑类接口每个OpenAPI应用限定调用接口次数为：每24小时最多调用 企业最大用户数*10次

工单模块 ​

获取所有工单类型 ​

开发者可以通过该API获取售后宝系统中企业所有的工单类型 可以获取每个工单类型的工单类型Id、工单类型名称、是否可用等等字段。更多详情见开发文档。

获取指定工单类型的自定义字段 ​

开发者可以通过该API获取售后宝系统中企业指定工单类型的自定义字段（不包括人员、附件、关联字段等）。 可以获取自定义字段的指定字段：字段唯一标识名、字段名称、字段类型、对应工单类型Id、对应工单类型名称、默认值等等。更多详情见开发文档。

获取指定工单编号的工单详情信息 ​

开发者可以通过该API获取售后宝系统中企业指定工单编号的工单详情（目前只开放部分数据，不包括附加组件）。 可以获取工单的部分数据信息：该工单对应类型Id，类型名、工单编号、工单状态、来源、负责人、协同人、客户名、联系人信息、分配时间、完成时间、自定义字段等等。更多详情见开发文档。

获取指定工单编号的工单进度信息 ​

开发者可以通过该API获取售后宝系统中企业指定工单编号的所有工单进度。 可以获取工单的全部进度信息：每条进度信息的操作人、进度时间、工单编号、客户名称、地址信息、经纬度等等。更多详情见开发文档。

新建工单 ​

开发者可以通过该API新建指定工单类型的工单。 该API可以实现全部系统字段和除人员、附件、关联字段外所有的自定义字段的注入工单表单。 工单新建成功后的工单进度为：[API应用操作负责人]通过API应用[API应用名]新建了工单 #[工单编号]

获取指定工单或者指定工单类型所关联的附件组件 ​

开发者可以通过该API获取售后宝系统中企业指定工单或者指定工单类型所关联的附件组件。 可以获取关联的附加组件的组件信息：组件Id，组件名称，组件描述，组件类型等等。更多详情见开发文档。

获取指定附加组件的自定义字段 ​

开发者可以通过该API获取售后宝系统中企业指定的附加组件上的自定义字段。 可以获取自定义字段的信息：字段唯一标识名、字段名称、字段类型、提示信息等等。更多详情见开发文档。

为指定工单添加附件组件信息 ​

开发者可以通过该API为指定工单添加附件组件信息。 该API可以实现除人员、附件外所有的自定义字段的注入工单的附加组件。更多详情见开发文档。

获取指定工单编号的附加组件信息 ​

开发者可以通过该API获取售后宝系统中企业指定工单编号的所有附加组件的已存在信息。 可以获取工单的全部附件组件信息：单次/多次附加组件信息的字段值、操作人、操作时间等。更多详情见开发文档。

事件模块 ​

获取所有事件类型 ​

开发者可以通过该API获取售后宝系统中企业所有的事件类型 可以获取每个事件类型的事件类型Id、事件类型名称、是否可用等等字段。更多详情见开发文档。

获取指定事件类型的自定义字段 ​

开发者可以通过该API获取售后宝系统中企业指定事件类型的自定义字段（不包括人员、附件、关联字段等）。 可以获取自定义字段的指定字段：字段唯一标识名、字段名称、字段类型、对应事件类型Id、对应事件类型名称、默认值等等。更多详情见开发文档。

根据特定条件获取事件列表 ​

开发者可以通过该API获取售后宝系统中企业的事件列表，支持部分条件（客户编号、状态、产品ID、创建时间等）查询、分页、部分字段（创建时间等）排序。 可以获取事件的部分数据信息：该事件对应类型Id，类型名、事件编号、事件状态、来源、负责人、协同人、客户名、联系人信息、分配时间、完成时间、自定义字段等等。更多详情见开发文档。

获取指定事件编号的事件详情信息 ​

开发者可以通过该API获取售后宝系统中企业指定事件编号的事件详情（目前只开放部分数据，不包括附加组件）。 可以获取事件的部分数据信息：该事件对应类型Id，类型名、事件编号、事件状态、来源、负责人、协同人、客户名、联系人信息、分配时间、完成时间、自定义字段等等。更多详情见开发文档。

获取指定事件编号的事件进度信息 ​

开发者可以通过该API获取售后宝系统中企业指定事件编号的所有事件进度。 可以获取事件的全部进度信息：每条进度信息的操作人、进度时间、事件编号、客户名称、地址信息、经纬度等等。更多详情见开发文档。

新建事件 ​

开发者可以通过该API新建指定事件类型的事件。 可以新建外部事件和内部事件，并为其设置是否自动分配。 事件新建成功后的事件进度为：[API应用操作负责人]通过API应用[API应用名]新建了事件 #[事件编号]

1.外部事件 ​

企业的客户通过自主门户发起的事件请求为外部事件，此类事件不关联系统中的客户信息，客户发起请求时填写的信息只用于显示。开发者通过不填写客户编号来新建此类事件。

2.内部事件 ​

企业员工通过系统新建的事件为内部事件，此类事件关联系统中的客户信息。开发者通过填写正确的客户编号来新建内部事件。

客户模块 ​

获取客户模版的自定义字段 ​

开发者可以通过该API获取售后宝系统中客户模版的自定义字段（不包括人员、附件、关联字段等）。 可以获取自定义字段的指定字段：字段唯一标识名、字段名称、字段类型、默认值等等。更多详情见开发文档。

获取指定客户编号的客户详情信息 ​

开发者可以通过该API获取售后宝系统中企业指定客户编号的客户详情（目前已开放所有数据信息）。 可以获取客户详情信息：该客户对应客户编号、客户状态、客户负责人、服务团队、客户名、联系人信息、自定义字段等等。更多详情见开发文档。

新建客户 ​

开发者可以通过该API新建客户。 该API受到售后宝系统客户管理设置中的部分设置的限制： 1.将客户地址字段设置为非必填项 2.客户自动编号 3.验证客户联系人电话号码是否重复 4.允许客户名称重复 客户新建成功后的客户进度为：[API应用操作负责人]通过API应用[API应用名]新建了客户 #[客户编号]

产品模块 ​

获取产品的自定义字段 ​

开发者可以通过该API获取售后宝系统中产品的自定义字段（不包括人员、附件、关联字段等）。 可以获取自定义字段的指定字段：字段唯一标识名、字段名称、字段类型、默认值等等。更多详情见开发文档。

获取所有产品列表\根据客户编号获取产品列表 ​

开发者可以通过该API分页获取售后宝系统中所有的产品列表和指定客户的产品列表，列表展示的数据为产品的详情数据。 可以获取客户详情信息：该客户对应产品编号、产品名称、产品系统编号、客户名、自定义字段等等。更多详情见开发文档。

新建产品 ​

开发者可以通过该API新建产品。 该API受到售后宝系统产品管理设置中的部分设置的限制： 1.产品编号唯一性验证 产品新建成功后的产品最新进度为：[API应用操作负责人]通过API应用[API应用名]新建了产品

编辑产品 ​

开发者可以通过该API编辑系统中已经存在的产品。 该API受到售后宝系统产品管理设置中的部分设置的限制： 1.产品编号唯一性验证 产品编辑成功后的产品最新进度为：[API应用操作负责人]通过API应用[API应用名]编辑了产品 修改字段：产品类型

备件模块 ​

查询所有备件品类 ​

开发者可以通过该API获取售后宝系统中企业指定备件编号的备件详情。 可以获取备件品类的部分数据信息：该备件的名称、类别、规格、单位、销售价、出库价、创建事件等。更多详情见开发文档。

查询指定备件的库存 ​

开发者可以通过该API获取售后宝系统中企业指定备件在指定仓库中的库存。 可以获取库存相关的部分数据：备件名称、备件编号、备件规格、仓库名称、仓库类型、库存数量、安全库存等。更多详情见开发文档。

新建备件品类 ​

开发者可以通过该API在售后宝系统中新建备件品类。 开发者指定备件的名称、编号、类别、规格、单位、销售价、出库价等字段信息，即可新建一个备件品类， 新建成功后，在售后宝系统的备件品类详情页中会生成一条动态信息：[API应用操作负责人]通过API应用[API应用名]新建了备件。 更多详情见开发文档。

编辑备件品类 ​

开发者可以通过该API更新售后宝系统中指定备件品类的信息。 开发者指定要编辑的备件的编号，以及要修改的字段信息，即可修改该备件品类。 备件编辑成功后，在售后宝系统的备件品类详情页中会生成一条动态信息：[API应用操作负责人]通过API应用[API应用名]编辑了备件。 更多详情见开发文档。

备件出入库 ​

开发者可以通过该API对售后宝系统中的指定备件进行出入库操作。 开发者指定要出入库的备件编号、仓库名称、出入库类型、数量等字段信息，即可进行出入库操作。 出入库成功后，在售后宝系统的出入库记录页面会生成一条记录。 更多详情见开发文档。

主动推送模块 ​

开发者在API设置-API选项中开启主动推送功能后，可以在应用中配置主动推送内容。

工单主动推送 ​

当企业开启了API选项-主动推送并且在某个API应用中配置成功了消息推送内容后，在售后宝系统中，当指定的工单类型的工单发生状态变化（新建、指派、开始、完成等18个节点，详情见开发文档的工单状态编码对照表）的时候，系统会主动向应用中配置的消息推送地址推送一条工单状态变化的数据信息。 详细配置方式见开放文档。

事件主动推送 ​

详细配置方式见开放文档。

客户产品主动推送 ​

详细配置方式见开放文档。

备件主动推送 ​

详细配置方式见开放文档。

获取开发文档 ​

https://www.yuque.com/docs/share/28839dcf-9c2c-4bec-8d52-d3f54e4187fc?# 《售后宝开放API文档V2.8-Beta》