API发布后,您可前往API网关控制台下载SDK,然后在应用中使用该SDK调用API,或构造URL调用API。
调用方式
调用方式 | 适用场景 | 说明 | 安全级别 |
加密签名身份认证 | 应用程序开发、数据采集等。 | 该方式需要在SDK中使用数据服务中的AppKey和AppSecret。具体操作,请参见使用SDK调用API。 | 高 |
简单身份认证 | 一般用于可视化场景,如DataV调用。 | 该方式需要AppCode,适用于通过直接构造URL访问API数据。 | 低 |
通过API网关SDK调用API
前提条件
步骤一:下载SDK
进入API网关控制台的已授权API的SDK页面。
找到数据服务默认生成的DMS_DEFAULT_APP应用,单击右侧的各语言按钮进行下载SDK及文档(支持Objective-C、Android、Java)。
说明其他语言的SDK(PHP/NodeJS/Python/.Net)参考控制台下方调用示例进行下载。
从其他渠道(云市场)获得授权的API,请参见调用API商品进行操作。
如果是RAM用户(子账号)访问,则阿里云账号(主账号)需要为其添加访问API网关资源的权限。API网关有2个官方权限策略,其中管理权限:AliyunApiGatewayFullAccess,只读权限:AliyunApiGatewayReadOnlyAccess。更多为子账号授权的信息,请参见使用RAM管理API。
步骤二:通过SDK调用API
登录数据管理DMS 5.0。
在顶部菜单栏中,选择 。
说明若您使用的是极简模式的控制台,请单击控制台左上角的图标,选择
。单击API调用页签,找到加密签名身份认证的AppKey和AppSecret。
在应用中使用SDK调用API。更多调用API信息,请参见客户端调用API示例。
构造URL调用API
登录数据管理DMS 5.0。
在顶部菜单栏中,选择 。
说明若您使用的是极简模式的控制台,请单击控制台左上角的图标,选择
。在API调用页面,复制Endpoint地址。
说明不同地域DMS的Endpoint地址有差异,请以DMS控制台实际展示的地址为准。
在浏览器地址输入栏中,输入
Endpoint地址
+API路径
+?AppCode=XXXXX
后,单击Enter。本示例基于定义API时,未设置请求参数,调用地址:
https://c1c174da5e8d431ca579b953b38d1b8e-cn-hangzhou.alicloudapi.com/item/add/path13?AppCode=9fXXXXX
。说明若您在定义API时设置了请求参数,则需要在AppCode后增加请求参数信息,格式为
AppCode=XXXXX&请求参数名称
。例如AppCode=9fXXXXX&Id=3。此时系统将会下载一个名为ApiResponseForInnerDomain的返回结果文件至本地。