开放平台

• 1: API手册
• 2: API管理
• 3: 事件管理
• 4: 接入应用

1、概述

提供完备的OpenAPI数据开放能力和授权管理能力。

2、能力导图

3、角色权限定义

4、能力特征清单

1 - API手册

1、概述

展示COP平台所有OpenAPI和应用错误码信息。

2、能力特征

3、使用场景

3.1、场景化接口清单

提供基于场景的API清单，便于特定场景的API查看。

4、平台错误码

2 - API管理

1、概述

提供全量API刷新、API启用/停用、接口内容查看、全量接口文档导出能力。

2、能力特征

3、使用场景

3.1、API启用/停用

属于API一级授权，只有启用的接口，在配置接入应用时才可以查看并进行二次授权。

3.2、接口文档导出

接入应用中的接口文档导出，可以导出对应应用已授权的接口文档，API管理中的导出，可以导出所有启用的接口文档。

3.3、API刷新

API主要来源于原生应用（组织模型、事项中心）、自建应用（UDC定制应用）、三方API（三方集成应用），针对后两个API来源，需要应用发布并启用后，在API管理页刷新API才可以查看对应API。

3 - 事件管理

1、概述

提供全平台事件查看、启用/停用、事件内容查看能力。

2、能力特征

3、使用场景

3.1、事件启停

事件一级授权，只有启用的事件，才可以在接入应用中选择并进行二次授权使用。

4 - 接入应用

1、概述

为每一个需要访问COP平台OpenAPI和事件的三方应用系统，分配独立的授权信息，并监控调用日志。

2、能力特征

2.1、接入应用管理

2.2、OpenAPI授权

2.3、事件订阅授权

2.4、安全设置

2.5、使用日志

2.6、nacos高级设置

3、使用场景

3.1、接口授权

集成平台提供两层接口授权机制，第一级授权叫做API启用，启用后所有接入的应用才可以查看响应接口，并进行二次授权，一级授权目的是限制接口使用范围和场景，提高系统可用性和稳定性。

当API启用后，管理员可以针对每个接入应用，添加二级授权，被授权应用只可以访问当前应用已经授权的接口。

3.2、接口文档

添加二级授权后，被授权应用可以自动导出已授权接口的接口文档。接口文档以Word形式导出，且系统采用异步导出接口文档形式，降低内存消耗。

3.3、事件订阅

平台提供的事件同样遵循二级授权管理模式，由COP定义事件消息体，三方系统提供事件接收URL，COP平台触发事件后，三方系统就可以实时接收到对应的事件提醒和事件内容。

3.4、IP白名单

平台提供访问白名单机制，如果未配置白名单，则所有网络联通，且拥有平台颁发的AppKey和APPSecret的调用方都可以正常调用对应授权接口。开启白名单后，只有出口IP一致的调用方才可以正常调用已授权接口。

平台提供签名启用/停用配置，启用后，调用接口需要APPKey和AppSecret；停用时，调用方只需要提供AppKey即可，不需要提供APPSecret和签名sign。停用签名场景主要针对客户有企业级开放平台时或者防火墙策略完善场景。

3.5、请求限流

平台提供访问限流控制，管理员可以配置不限流，或者配置周期内访问次数限制，主要针对服务器资源紧张、内存压力大场景。

3.6、接口调用demo

场景：比如外部需要调用接入应用中开放的组织机构人员信息查询接口，该接口业务参数是人员id。
由于demo中使用了技术平台JsonUtils、MD5、HttpClientUtil等工具类，所以需要您在您工程中依赖boot-core

<dependency>
    <groupId>com.seeyon</groupId>
    <artifactId>boot-core</artifactId>
    <version>3.9.0</version>
</dependency>

java代码如下：

import com.seeyon.boot.util.JsonUtils;
import com.seeyon.boot.util.MD5;
import com.seeyon.boot.util.http.HttpClientUtil;
import com.seeyon.boot.util.http.common.HttpHeader;

import java.util.HashMap;
import java.util.Map;

/**
 * Description:
 * Author: weijh
 * Date: 2024/11/5 15:30
 */
public class OpenApiTest {
    public static void main(String[] args) {
        String appKey = "您的appKey";
        String appSecret = "您的appSecret";
        Map<String, Object> param = new HashMap<>();
        Long reqId = System.currentTimeMillis();
        param.put("requestId", reqId);
        param.put("timestamp", reqId);
        param.put("data", "人员id");


        HttpHeader httpHeader = HttpHeader.custom();
        httpHeader.add("app-key", appKey);
        httpHeader.add("sign-type", "MD5");
        String jsonStr = JsonUtils.toJson(param);
        String sign = MD5.getMD5String(appSecret + jsonStr + appSecret);
        httpHeader.add("sign", sign);
        String result = HttpClientUtil.post("https://openapi-pre.seeyonv8.com/organization/base/member/selectById", jsonStr, httpHeader);
    }
}

3.7、postman调用demo

openapi-demo调用.postman_collection.json