概述
您作为API调用者,需要实现一个API的调用,那么您需要完成以下工作:
1.获取API
从服务目录获取需要调用API。仅在API发布后,才支持被调用。
2.(可选)创建应用并获取授权
对于使用APP和IAM认证的API,需要完成创建应用和将API授权给应用。在API调用过程中,使用所创建应用的密钥对(AppKey、AppSecret),数据服务根据密钥对进行身份核对,完成鉴权。
3.调用API
API调用者完成以上步骤后,可以进行API调用。
创建应用
1.在DataArts Studio控制台首页,选择实例,点击“进入控制台”,选择对应工作空间的“数据服务”模块,进入数据服务页面。
详见下图:选择数据服务
2.在左侧导航栏选择服务版本(例如:专享版),进入总览页。
3.单击“调用API > 应用管理”,进入到应用管理页面。单击“新建”,弹出“新建应用”对话框。填写如表3-363所示信息。
详见下表: 应用信息
信息项 | 描述 |
---|---|
应用名称 | 应用名称。 |
应用类型 | IAM:使用IAM认证,即token访问。 APP:对接APP,通过APP认证方式访问。 |
描述 | 对应用的介绍。 |
4.单击“确定”,创建应用。
创建应用成功后,在“应用管理”页面的列表中显示新创建的应用和应用ID。
5.单击“应用名称”,进入应用详情页面,查看AppKey和AppSecret。
将API授权给应用
1.在DataArts Studio控制台首页,选择实例,点击“进入控制台”,选择对应工作空间的“数据服务”模块,进入数据服务页面。
详见下表: 选择数据服务
2.在左侧导航栏选择服务版本(例如:专享版),进入总览页。
3.通过以下任意一种方式,将API授权给应用。
主动授权:
a.单击“开发API > API管理”,进入到API管理页面。
b.在待绑定应用的API所在行,单击“查看授权”,进入API完整信息界面。
在“授权信息”页签中,单击“添加授权”。
c.设置授权的截止时间,勾选应用名称,单击“确认授权”,完成API的授权。
申请授权:
a.单击“调用API > 服务目录”,进入服务市场主页面。
b.单击待绑定应用的API名称,进入API完整信息页面。
c.在“调用信息”页面,单击“申请权限”。
d.设置使用截止时间并选择应用名称,单击“确认”。
e.申请后,需要等待审核中心审核,方可授权成功。
4.授权成功后,可以在应用管理详情页面查看已绑定的API。
说明
如果已绑定API列表中包含无需绑定的API,在此API所在行的操作列,单击“解绑”,将无需绑定的API删除。
如果需要调试已绑定的API,单击“测试”,进入调试页面。
如果需要对已绑定的API延长授权时间,单击“续约”。
调用API
以下三种认证方式区别仅在于认证的内容不同,调用API的方式是相同的。
- “IAM认证”:需要借助IAM服务进行安全认证。
- “无认证”:不需要认证,直接调用API即可。
- “APP认证方式”:API调用者通过APP认证方式调用API。
−使用APP认证时,需要通过SDK访问。
−其中SDK访问提供了基于Java、Go、Python、JavaScript、C#、PHP、C++、C、Android等多种语言的SDK包。
−各个语言调用API示例请参考《数据治理中心 SDK参考》“使用APP认证调用API”的Java、Go、Python、C#、JavaScript、PHP、C++、C、Android、curl章节。