注册Open API数据源¶
本文描述了如何配置与 Open API 数据源的连接。
关于任务 ¶
要通过 Open API 的方式接入数据,需要先配置该数据源的信息以及创建与目标 API 服务的连接。
步骤 ¶
登录 EnOS 管理控制台,从导航栏中选择 数据源注册。
点击 新增数据源,并完成以下基本信息配置:
- 数据源类型:选择 OPENAPI。
- 数据源名称:输入数据源的名称。数据源名称的最大长度为50个字符,名称可以是以下字符的组合:
- 中文
- a - z
- A - Z
- 0 - 9
- _ (下划线)
- -(短横线)
- 数据源描述:输入对数据源的描述。
在 请求设置 一栏中,完成以下 API 服务的请求参数配置:
- 服务地址:输入 API 服务的地址,例如
https://{apigw-address}
- Method:选择 API 请求方式(GET 或 POST)
- 请求路径:输入 API endpoint 的路径,例如
/model-service/v2.1/thing-models?action=get
- 请求参数:点击 添加参数,逐个输入和配置 API 的请求参数
- 服务地址:输入 API 服务的地址,例如
在 返回结果设置 一栏中,完成以下 API 服务的返回参数配置:
- Content Type:目前支持选择
application/json;charset=utf-8
- Success Code:输入成功调用 API 的返回码
- Dataset Type:选择数据集类型(object 或 object array)
- Dataset:输入数据集
- Content Type:目前支持选择
选择 API 鉴权类型(无鉴权或普通Token鉴权);若选择 普通Token鉴权,需对应地配置 Token 服务和参数。
(可选)选择 API 返回结果翻页类型,并对应地配置翻页参数。
(可选)配置数据获取参数。
结果 ¶
数据源注册成功后,该数据源项将显示在 数据源注册 的列表中。