创建API数据源
通过创建API数据源能够实现Dataphin向API请求业务数据或向API请求写入数据。本文为您介绍如何创建API数据源。
使用限制
Dataphin仅支持超级管理员、数据源管理员、板块架构师、项目管理员角色创建数据源。
超级管理员、数据源管理员角色添加与配置请参见添加、配置及管理Dataphin成员。
板块架构师配置请参见创建数据板块。
项目管理员配置请参见添加项目成员。
操作步骤
请参见数据源管理入口,进入数据源管理页面。
按照下图指引,进入新建数据源对话框。
在新建数据源对话框的半结构化存储区域,选择API。
如果您最近使用过API,也可以在最近使用区域选择API。同时,您也可以在搜索框中,输入API的关键词,快速筛选。
在新建API数据源对话框中,配置相关连接数据源参数。
配置数据源的基本信息。
参数
描述
数据源名称
命名规则如下:
只能包含中文、字母、数字、下划线(_)或中划线(-)。
长度不能超过64字符。
数据源描述
对数据源的简单描述。不超过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令牌信息。该信息将添加至API的headers中进行请求。
单击确定,完成API数据源的创建。
后续步骤
完成API数据源的创建后,即可将API的业务数据引入至Dataphin,或将Dataphin的数据写入至API数据源。更多信息,请参见数据集成概述。