写入API

1 概述

1.1 版本

1.2 应用场景

用户可自行定义接口，将数据实时写入，并提供一系列与数据相关的服务。

2 功能入口

点击「数据服务>API管理」，可进行API写入的管理。如下图所示：

3 功能简介

主要用于将离线任务包装成一种接口，将数据推送至指定的API接口。。

4 功能说明

新建一个写入 API 后，需要 4 步即可完成该 API 的设计，具体包括：基本信息、数据去向、API授权、API测试。

4.1 基础信息

基本信息包括请求方式、、请求Body格式、路径、超时时间等配置，如下图：

功能说明如下：
1、请求方式
暂只支持POST请求，POST请求是通过Body传入参数。
2、请求Body格式
请求方式为“POST”的特有配置，需要指定请求的Body格式，即请求Content-Type，暂只支持：application/json
3、路径
API对外发布的API路径，由头部固定格式+自定义路径组成：
固定格式：oapi/dataService/${API集key}/，其中API集key是该API绑定API集时产生的，显示的是对应API集的内部名称。
自定义路径：允许用户自定义的路径内容，支持输入小写字母、数字、下划线（_）、连字符（-）、正斜杠（/），不能以/开头或结尾。
4、超时时间
指的是调用接口时响应超时时间，如果在指定时间后仍没有返回查询结果，则接口返回超时错误。

4.2 数据去向

4.2.1 任务

支持选择数据开发中已发布的任务。

4.2.2 任务参数

显示所选任务中包含的所有参数，支持参数启用/禁用、参数值配置，主要用于请求参数的定义。
参数值支持常量和表达式，允许定义请求参数，也是${参数名称}，用来接收请求参数的值用于数据查询。
参数值非请求参数时，最终将根据此处设置的默认值进行数据查询。

4.2.3 请求参数

实时解析任务参数中同时满足以下条件的参数：
1）参数是启用状态；
2）参数值类型为“表达式”；
3）值内容中含${参数名称}。
解析出来的请求参数功能同“数据连接”类型的请求参数。

4.3 API授权

同查询API。

4.4 API测试

用户可通过API测试对API接口进行调试，查看接口执行情况。

测试API集：若“API授权”步骤中绑定了API集，则此处需要选择绑定的其中一个API集进行测试。
API地址：根据配置的请求方式及路径自动生成对应的API地址。
参数信息
左侧含有「Body」和「Headers」两个tab，「Body」中显示请求参数，「Headers」中显示该API的请求body格式和当前应用的内部名称。

5 API上线

API测试无误后，用户点击完成即可查看该API的详情。

新建的API默认为“下线”状态，在右上角点击“上线”即可将该API上线，有访问权限的外部系统通过对应认证后即可访问该API。
若用户需变更其相关信息，则需先通过“下线”操作”将该API下线，再点击“编辑”进修改。