本篇介绍了通过开放平台接入事务服务,如何调用事务接口实现待办创建、完成等流程。

# 接入流程简介

第一步:注册开放平台,获取接口权限和访问凭证

第二步:开通事务服务能力,以获取使用事务接口能力的权限。

第三步:在事务服务下添加事务类型,在调用事务服务时使用。

第四步:调用事务相关API

# 第一步 注册开放平台并申请权限与访问凭证

# 1. 注册应用

  • 管理员登录云平台,进入开放平台-应用服务管理中创建应用。

  • 应用创建成功后,开发者进入开放平台可以查看应用的Appid(唯一身份标识)。

注册应用

# 2. 申请API权限

  • 开发者登录开放平台,进入已注册的应用,申请平台OpenAPI能力
  • 能力申请成功后,系统自动生成Client Id与Client Secret,请开发者记录下来,以便后续使用能力时使用

申请API权限

# 3. 申请API

  • 开发者在平台OpenAPI-接口权限列表中申请需要的接口,等待管理员审核。
  • 接口申请成功后,在平台OpenApi-我的里面查看scope信息

申请API

# 4. API鉴权

  • 开发者使用Client Id、Client Secret以及Scope去换取access Token。在调用接口时,通过access Token鉴权调用者身份。

# 第二步 开通事务服务

在开放平台开通事务服务的同时,系统会自动在事务服务中注册应用,作为使用事务服务的应用身份,在调用接口时使用开放平台的appid即可。

  • 开发者登录开放平台,在开放能力列表选择事务中心,申请开通。

开通事务服务

# 第三步 创建事务类型

事务类型是事务场景的抽象,在事务类型中可以配置消息通知、批量办理等,并且在统计分析时能够作为一项依据。

业务方在平台发起事务时,需要用到事务类型,有以下两种方式:

  • 提前场景事务类型,在发起事务时使用已创建的事务类型。

  • 无需提前创建事务类型,在发起事务时自动创建事务类型。使用这种方式,业务方应该保证每次发起相同类型的事务时,使用同一个事务类型ID,避免重复创建事务类型。

能力开通后,开发者在事务中心创建事务类型。

创建事务类型

事务类型说明

# 第四步 调用事务相关API

平台为事务能力接入提供两套接口能力,分别适用于简单的业务场景和复杂(流程类)的业务场景,业务方根据实际业务情况进行选择。

API 描述 示例
简单事务
(V1.3.1及以上)
简单的业务,通常需要一人或多人完成相同的待办,如志愿填报、活动报名等。 API调用示例
流程事务 复杂的流程类业务,需要完成多条待办,待办之间存在如串行、并行的关联关系,如入职面试、费用报销等审批流程。 API调用示例