文档

调用API

API发布后,您可前往API网关控制台下载SDK,然后在应用中使用该SDK调用API,或构造URL调用API。

调用方式

调用方式

适用场景

说明

安全级别

加密签名身份认证

应用程序开发、数据采集等。

该方式需要在SDK中使用数据服务中的AppKey和AppSecret。具体操作,请参见使用SDK调用API

简单身份认证

一般用于可视化场景,如DataV调用。

该方式需要AppCode,适用于通过直接构造URL访问API数据。

通过API网关SDK调用API

前提条件

  • 已在DMS数据服务中发布API。具体操作,请参见发布API

  • 已在API网关中创建APP(应用)。具体操作,请参见概述

    说明

    由于调用API的是应用,因此需要在API网关中创建应用,通过应用对应的相关身份识别信息进行调用(API Owner拥有一个默认应用及对应的身份识别信息)。

  • 已授权APP调用目标API。具体操作,请参见API授权

    若您为API Owner,则无需进行授权操作(在发布API时,数据服务已默认为API Owner授予APP调用API的权限)。

步骤一:下载SDK

  1. 进入API网关控制台的已授权API的SDK页面。

  2. 找到数据服务默认生成的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

  1. 登录数据管理DMS 5.0

  2. 在顶部菜单栏中,选择集成与开发(DTS) > 数据应用 > 数据服务

    说明

    若您使用的是极简模式的控制台,请单击控制台左上角的2023-01-28_15-57-17.png图标,选择全部功能 > 集成与开发(DTS) > 数据应用 > 数据服务

  3. 单击API调用页签,找到加密签名身份认证AppKeyAppSecret

  4. 在应用中使用SDK调用API。更多调用API信息,请参见客户端调用API示例

构造URL调用API

  1. 登录数据管理DMS 5.0

  2. 在顶部菜单栏中,选择集成与开发(DTS) > 数据应用 > 数据服务

    说明

    若您使用的是极简模式的控制台,请单击控制台左上角的2023-01-28_15-57-17.png图标,选择全部功能 > 集成与开发(DTS) > 数据应用 > 数据服务

  3. API调用页面,复制Endpoint地址。

    说明

    不同地域DMS的Endpoint地址有差异,请以DMS控制台实际展示的地址为准。

  4. 在浏览器地址输入栏中,输入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。

  5. 此时系统将会下载一个名为ApiResponseForInnerDomain的返回结果文件至本地。

  • 本页导读 (1)
文档反馈