通过创建API数据源能够实现Dataphin向API请求业务数据或向API请求写入数据。本文为您介绍如何创建API数据源。
权限说明
仅支持拥有新建数据源权限点的自定义全局角色和超级管理员、数据源管理员、板块架构师、项目管理员系统角色创建数据源。
操作步骤
在Dataphin首页，单击顶部菜单栏管理中心 > 数据源管理。
在数据源页面，单击+新建数据源。
在新建数据源页面的半结构化存储区域，选择API。
如果您最近使用过API，也可以在最近使用区域选择API。同时，您也可以在搜索框中，输入API的关键词，快速搜索。
在新建API数据源页面中，配置相关连接数据源参数。
配置数据源的基本信息。
参数
描述
数据源名称
命名规则如下：
只能包含中文、英文字母大小写、数字、下划线（_）或短划线（-）。
长度不能超过64字符。
数据源编码
配置数据源编码后，您可以在Flink_SQL任务中通过
数据源编码.表名称或数据源编码.schema.表名称的格式引用数据源中的表；如果需要根据所处环境自动访问对应环境的数据源，请通过${数据源编码}.table或${数据源编码}.schema.table的变量格式访问。更多信息，请参见Flink_SQL任务开发方式。重要数据源编码配置成功后不支持修改。
数据源编码配置成功后，才能在资产目录和资产清单的对象详情页面进行数据预览。
Flink SQL中，目前仅支持MySQL、Hologres、MaxCompute、Oracle、StarRocks、Hive、SelectDB数据源。
数据源描述
对数据源的简单描述。不超过128字符。
数据源配置
选择需要配置的数据源：
如果业务数据源区分生产数据源和开发数据源，则选择生产+开发数据源。
如果业务数据源不区分生产数据源和开发数据源，则选择生产数据源。
标签
您可根据标签给数据源进行分类打标，如何创建标签，请参见管理数据源标签。
配置数据源与Dataphin的连接参数。
说明通常情况下，生产数据源和开发数据源需配置为非同一个数据源，以实现开发数据源与生产数据源的环境隔离，降低开发数据源对生产数据源的影响。但Dataphin也支持配置成同一个数据源，即相同参数值。
参数
描述
URL地址
请填写API请求的URL地址。
认证方式
请根据API的认证方式进行选择。
Basic Auth
用户名：填写API的用户名。
密码：填写API密码。
阿里云appKey auth
AppKey：填写API的AppKey。
AppSecret：填写API的AppSecret。
None：API无认证。
API Key
Key：填写API Key认证方式的键。
Value：填写API Key认证方式的值。
添加至：将API Key添加至API请求体参数Parameters、Headers、Body中的其中一个。
Bearer Token：填写Token令牌信息。该信息将以
Authorization: Bearer <token>的形式添加至API的Headers中进行请求。OAuth2.0：填写Access Token并配置下方的Access Token获取配置。
Access Token：填写Access Token获取配置的返回结果中的Access Token的JSON路径，支持多级，例如
data.access_token。
Access Token获取配置
说明仅当认证方式选择OAuth2.0时，支持配置此模块参数。
请求方式：可选择POST或GET，默认为GET。
Token URL：输入Token的请求地址，格式为
https://example.com/oauth/token。客户端ID：输入客户端的ID。
客户端密钥：输入客户端的密钥。
客户端认证：可选择在请求头中发送基本认证信息或在请求体中发送客户端凭证，默认为在请求头中发送基本认证信息。
在请求头中发送基本认证信息：在HTTP请求中直接通过
Authorization头字段发送基本认证信息。基本认证的基本格式为Authorization: Basic <credentials>，其中<credentials>是经过Base64编码的用户名和密码。在请求体中发送客户端凭证：将客户端认证信息发送至请求体中，kv形式为
client_id、client_secret。
高级配置
说明仅当认证方式选择OAuth2.0时，支持配置此模块参数。
请求参数：可填写多个请求Token需要的额外参数，默认为空。当此处填写的参数与上方认证自动添加的参数冲突时，以此处填写的参数为准。
参数名称：仅支持英文字母大小写、数字、下划线（_）和短划线（-），不超过256个字符。
添加到：可选Parameter、Header、Body，默认为Parameter。仅当请求方式为POST时，才可选择Body。
高级设置
连接重试次数：当连接API失败时，将自动重试连接，直到达到设定的重试次数。若达到设置的重试次数仍未连接成功，则判定为连接失败。
单击确定，完成API数据源的创建。