基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
如何批量导入商品
概述 云价签控制台可以通过API接口批量导入商品。详细信息 每个门店下都拥有独立的商品库，采用门店和商品条码可作为商品的唯一标识。门店创建好后，云价签系统提供API接口，可对接到...具体API对接方式，请联系阿里云技术支持。适用于 云价签
导出标准OAS定义
概述 本文主要介绍了API网关可以将API资源导出为标准OAS定义，结合API网关的 导入标准OAS定义，您可以：跨平台跨地域迁移数据：借助API网关的导出和导入功能，您可以方便地从其他平台或API网关导出OAS规范的API数据，并在其他地域或账号下...
Emas Serverless 是否可以对接阿里云的Redis，开启...
问题描述 Emas Serverless 是否可以对接阿里云的 Redis，开启Http触发之后能否对接API Gateway相关服务？解决方案 目前不支持内网打通Redis，Http触发也不支持API Gateway。适用于 Emas Serverless
ServiceParameter
ServiceParameters 描述"class="reference-link">描述 后端服务调用入参信息项的类型 节点名"class="reference-link">节点名 ServiceParameter 子节点"class=...其中REQUEST是需要API调用者传值，CONSTANT、SYSTEM两种类型对API调用者不可见
CreateAppSession-创建应用会话
创建应用会话，并启动一个应用进程，返回会话信息。接口说明 创建会话成功后，事件类型为 APP_START。应用启动的结果会通过以下消息通知。注意 仅限 API 对接模式，不适用于 H5 SDK 对接模式。名称 类型 是否必选 说明 success Boolean 是 ...
StopAppSession-停止应用会话
接口说明 发起停止、程序主动停止或程序崩溃等原因导致应用程序停止后，会通过此消息通知。事件类型为 APP_STOP。注意 仅限 API 对接模式，不适用于 H5 SDK 对接模式。名称 类型 是否必选 说明 success Boolean 是 停止是否成功。取值：...
API接入
本文介绍如何通过API接入渠道平台。在 接入>API接入 界面，根据业务需要查看 标准广告业务API对接文档/淘系拉新业务API对接文档，根据文档完成接入。
功能概述
本产品当前提供2种部署方式 自定义部署 企业可以通过PaaS API对接方式，自助将对话机器人能力部署在任意渠道上。具体方式为：企业自行对接渠道，获取用户对话消息，然后调用智能对话机器人聊天接口、获取机器人识别与回复结果，并将结果...
应用场景
API 网关为您在各种场景下开放API 提供支撑，具体有：支持建立 API 生态，将 API 开放给合作伙伴、开发者，实现企业核心能力的货币化；支持将 API 适配多端，如：移动、互联网、物联，实现系统前后端分离；支持内部系统整合，模块化、微...
使用外部授权 API
} 创建外部授权 API 本地编写完外部授权接口后，您需要前往 API 网关的控制台上配置一个对应的外部授权 API。操作步骤如下：进入 API 网关控制台页面，在左侧导航栏中选择 API 发布>外部授权 API。在外部授权 API 列表页，点击列表右上方的...
IP访问控制插件
5.接入WAF的同时跨VPC访问 有一种场景，用户的API需要同时对公网和内网提供服务，而在公网提供服务的时候，在API网关前接入了WAF中间件，需要API网关对WAF前的客户端做IP访问控制，同时需要对内网来源做IP访问控制。网关为了这种场景做了...
名词解释
名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算后放入请求中作为签名信息。加密签名 API请求中携带签名信息，用于网关对请求做身份验证。授权 授予某个APP调用某个API...
离线文本结果
离线文本结果，展示您通过API上传的质检数据的质检结果，需要您自行进行API对接。离线文本结果：展示通过 上传文本质检UploadData 接口上传的数据。与 数据集质检 主要的区别是，呼叫中心质检的数据是经过API对接后自动推送过来的，而数据...
支持 HTTPS
步骤2：绑定SSL证书 准备好以上材料，需要进行如下操作进行，登录API网关管理控制台【开放API】-【分组管理】，单击您需要绑定SSL证书的分组，查看分组详情。在绑定SSL证书，您首先需要您在API分组上绑定【独立域名】。【独立域名】-添加...
离线语音结果
离线质检结果，展示您通过API上传的质检数据的质检结果，需要您自行进行API对接。离线语音结果：展示通过 上传音频质检 接口上传的数据。与 数据集质检 主要的区别是，呼叫中心质检的数据是经过API对接后自动推送过来的，而数据集质检的...
应用场景
企业商城 LinkedMall 背靠阿里供应链体系，为...接口全面，灵活定制 提供标准对接API和开箱即用的SaaS软件服务两种服务方式，快速完成零库存分销业务搭建。多财资链路，灵活运营 支持买断和代销两种模式的分销，给渠道商更大的业务灵活度。
使用后端服务提高管理效率
API调试 授权成功后即可进行API调试，API网关提供了在线调试的功能，因此一般建议在API网关上完成API配置之后，可以先通过此功能确认API是否配置成功，然后再通过client端进行调用。在API列表页，选择之前创建的API，进入详情页，单击 调试...
后端路由
可以使用$CaAppId 形式来引用当前请求的系统参数，系统参数不需要API中被定义即可引用，但如果您在API中定义了重名的参数，取到的值会被自定义参数覆盖，可用于路由插件的系统参数列表如下：CaStage:当前API请求的环境，RELEASE,PRE,TEST ...
CreateApiGroup-创建API分组
接口说明 创建 API 需要先创建分组，所属分组是 API 的一个基本属性信息。此功能面向 API 提供者。每个用户每个区域下最多可创建 100 个分组。系统自动给分组分配二级域名，用于测试 API。分组带有区域属性，后续创建 API 选择分组后就选择...
API调用授权
BSS OpenAPI的权限为 bssapi:【API名称】，例如 bssapi:QueryOrder 或 bssapi:QueryInstanceBill。为了兼容控制台权限，以下表格中API对应的权限点同样可以使用。对于权限策略中，Allow或Deny一个API对应的任何一个权限点，权限策略都会...
导入标准OAS定义
API网关支持导入OAS 2.0和OAS3.0格式（详见 OpenAPI Specification）的API定义，帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。导入标准OAS格式的API定义 主要包括...
CreateApp-创建APP
接口说明 此功能面向调用 API 的用户 每个 APP 有一对 Key 和 Value 密钥对，该密钥在调用 API 时用于身份验证 APP 调用 API 需要建立授权关系，即授予 APP 调用某 API 的权限 一个 APP 下只能有一对密钥，若密钥泄露可以重置 每个阿里云...
外部授权
当 API 需要验证授权关系时，会调用该外部授权接口进行授权校验。外部授权接口不限制协议类型，但会限制请求体和响应体。请求和响应均为 JSON 字符串，格式如下：请求体 {"context":{"key":"value"} } 字段说明：Request 中只有一个 ...
基于JWT的token认证
一、基于token的认证 1.1 简介 很多对外开放的API需要识别请求者的身份，并据此判断所请求的资源是否可以返回给请求者。token就是一种用于身份验证的机制，基于这种机制，应用不需要在服务端保留用户的认证信息或者会话信息，可实现无状态...
基础对接指引
API调用对接指引 数据模型对接指引 设备数据订阅指引
ApiHisItem
StageName String 环境名称，可选值：RELEASE:线上 TEST:测试 ApiId String API编号 ApiName String API名称 Description String API描述 HistoryVersion String API定义的历史版本 Status String 对应版本的API是否生效，取值为：ONLINE、...
2.1 门禁对讲一体机对接方案介绍
蓝牙门禁 云端平台管理蓝牙卡权限，通过边缘服务器，下发蓝牙卡白名单到门禁机，门禁机通过蓝牙通信标准协议与手机APP通信，判断通行权限，设备需要开发对接边缘服务器卡权限和事件接口，蓝牙通信标准。可视对讲 设备端开发对接云端平台和...
账户/组织同步
Developer API 开发对接 应用 为了便于应用接入，IDaaS 提供了一套理解简单、接入容易的开发者 API，供自研应用调用。详情请参考：API概览。OpenAPI 开发对接 多种 IDaaS 开放 OpenAPI 供开发者调用，可用该系列接口批量导入账户。详情请...
ModifyVpcAccessAndUpdateApis-修改VPC授权信息，并且...
VpcName Token string 否 口令 c20d86c4-1eb3-4d0b-afe9-c586df1e2136 NeedBatchWork boolean 否~是否需要刷新关联的 API，警告 如果您的 VPC 授权需要更新，并且该授权被 API 关联并已经发布上线，需要配置为 true，否则您的 API 的后端...
应用场景
云产品的多样性：多变的需求背后是云产品的多样性，对接众多的云产品的api需要进行封装后才能和审批流程接口对接，一个统一接口是必须的。CADT可以很好的满足上述两点需求，模板定义能力，统一的流程接口可以快速和现有流程对接，无缝集成...
VPC下的用户使用API网关有什么要求？
需要保证 API 网关可以与相应底层服务通信，所以 VPC 下的用户需要使用 EIP 或 负载均衡，以便 API 网关调用您的底层服务。
JWT认证插件
ignoreExpirationCheck:true 时，会跳过 exp 的超期检查，否则网关会检查Token是否已超期 如果需要API网关将Token中的 claims 转发给后端应用，可以通过 tokenParameters 字段配置转发参数 claimName:token中claim的名字，当配置HS256,HS...
ApiGateway服务关联角色
本文为您介绍ApiGateway服务关联角色（AliyunServiceRoleForApiGateway）的应用场景以及如何删除服务关联角色。背景信息 ApiGateway服务关联角色（AliyunServiceRoleForApiGateway）是用户需要配置API后端为函数计算的情况下，为获取访问...
创建 API 分组
API 分组将网关上的 API 按照业务需求进行分组管理。同一分组下的 API 共享一个域名地址。您可以通过以下任一方式创建 API 分组：在分组列表中创建 API 分组 登录 API 网关控制台。在左侧导航栏单击 API 发布>API 分组，进入分组列表。单击...
I404NF错误码排查
这个报错是请求的Path或Method和API定义的不同，需要根据API定义来请求API。您可以从以下几个方面排查：如果分组有配置BasePath，需要将BasePath拼接到API请求Path的前面，例如您分组的BasePath为/test，API定义的请求Path为/nameid，那么...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
API报警设置
4.设置API分组的报警规则 1、如果需要对该API分组下的所有API应用相同的报警规则，进入API分组详情页，点击详情页右上角的 开启云监控。2、在第一次配置API分组云监控时，会有弹出框提示用户创建 API网关-监控服务关联角色。3、点击确定后...
设备数据对接指引
1、接口说明 设备通过物模型对接后，可以通过以下接口获取当前项目中的各类设备数据。接口名称 接口描述 getAppThing 获取物的基本信息 getAppThingServiceData 获取物的服务记录 getAppThingStatus 获取物的连接状态 getAppThingTopo 获取...
TCP连接超时时间配置
APIGatewayReaderTimeout需要大于后端业务处理时间 ClientReadTimeout需要大于APIGatewayBackendTimeout 我们举个例子，如果后端服务对于一个API的处理时间绝大部分在10秒以内，那么我们将APIGatewayBackendTimeout设置为10秒，...
- 产品推荐
- 这些文档可能帮助您