外部系统API登记

变更记录

1 简介

1.1 功能介绍

提供外部系统现有 API 的登记功能，将其作为集成云的一种资源，用于集成方案（数据集成方案/服务流程等）的配置，运行方案时将通过此资源及其对应的连接器调用对应的API。

1.2 应用场景

适用于在集成服务云中需要通过调用外部系统API进行数据处理的场景。

1.3 系统路径

【集成管理】→【API集成】→【API登记】→【外部系统API登记】

1.4 字段/按钮说明

字段说明：

按钮说明：

2 主要操作

2.1 基本信息填写

• 需要授权：对于需要授权才允许调用的API,请参看《API授权使用说明》

• 接口标识（URL）：对于通过WebAPI连接器调用的系统，该URL由对应的API调用脚本处理，通常应该以斜线开头，不应该包含服务器IP和端口部分；其他类型连接器调用的系统，该URL由对应连接器解释。请确保所填URL可以被识别。

  集成云提供的对外服务接口参考《集成云对外服务接口说明》

• 输入/输出：结构类型的字段通过字段名之间加小数点（.）来定义内部结构，内部结构字段必须声明在结构字段之后； 输入分录的默认只会在此项输入未填或者为null时程序自动替换；输出分录中的定义不会对实际API的调用结果产生影响

  
  

2.2 操作

禁用/启用：启用后，会在开放平台生成一项API服务，禁用则删除对应的API服务。

测试：如果API需要授权调用，请在URL的caller参数后面输入有权限的调用者编码。

生成文档：将外部系统API的相关信息和调用方式生成PDF文档。用户可在文档中获取调用url,参数的输入结构等信息。

3 应用举例

3.1 通过URL调用

服务的详细信息请参阅《集成云对外服务接口说明》的1.6节。

注意：需要授权的API请在caller后面添加调用者编码

注意：在Headers中设置请求头：Content-Type为application/json; charset=UTF-8 和access_token

Java代码调用API示例：

String url = "";    //填入你的url
Map<String, Object> data = new HashMap<>();
data.put("exeNumber", "46EF370B-KD_CurrencyAddUpdate(");
HttpURLConnection http = (HttpURLConnection) new URL(url).openConnection();
data.put("exeNumber", "46EF370B-KD_CurrencyAddUpdate(");
HttpURLConnection http = (HttpURLConnection) new URL(url).openConnection();
http.setRequestProperty("Content-Type", "application/json; charset=utf-8");
http.setRequestProperty("access_token", "你的access_token");
http.setRequestMethod("POST");
http.setDoOutput(true);
byte[] bytes = Json.toString(data, true).getBytes(StandardCharsets.UTF_8);
OutputStream os = http.getOutputStream();
os.write(bytes);
os.flush();
if (http.getResponseCode() == 200) {
    InputStream reader = http.getInputStream();
    try {