API类商品使用
API认证方式概述
在调用API商品时,首先您需要了解采用哪种API认证方式,云商店API商品的认证方式可以支持"签名认证、简单身份认证(AppCode、MCPAppCode)"两种方式。两种方式可同时使用,您可以根据不同情况来选择。
签名认证(推荐):客户端程序使用AppSecret,对一系列需要签名所需要的信息 进行哈希运算(一般会使用 hmacSha256 算法),得到签名结果(一串字符串)。在调用API时,Request Header增加签名结果和AppKey的内容,从而进行身份认证。如何使用签名认证接入请参考签名认证调用操作步骤。
简易身份认证:
- AppCode:客户端程序将AppCode放到Request Header中,或者放到Request的Query参数中,从而进行身份认证,如何使用AppCode接入请参考简单身份认证(AppCode)调用操作步骤。
- MCPAppCode:MCP(Model Context Protocol)是一个开放协议,旨在打通大语言模型(LLM)应用与外部数据源、工具之间的交互壁垒。使用MCPAppCode接入可以更高效、更便捷地实现Agent应用与成千上万的外部工具与数据的互通,极大提升了开发效率和灵活性,如何使用MCPAppCode接入请参考MCP类商品使用指导。
API商品计费规则
|
API商品类型 |
HTTP状态码(HTTP Status Code) |
调用接口时间 |
|
按次套餐包 |
任何状态码 |
2025年7月16日前 |
|
HTTP 2XX [200,300) |
2025年7月16日起 |
|
|
按需、按需套餐包 |
HTTP 2XX [200,300) |
/ |
API商品计费规则
|
API商品类型 |
HTTP状态码(HTTP Status Code) |
调用接口时间 |
|---|---|---|
|
按次套餐包 |
任何状态码 |
2025年7月16日前 |
|
HTTP 2XX [200,300) |
2025年7月16日起 |
|
|
按需、按需套餐包 |
HTTP 2XX [200,300) |
/ |
查询API商品调用认证信息
用户购买成功后,可以到"云商店-买家中心-已购买服务"中,查看API调用所需要的认证信息,认证信息是由APIG网关统一创建。
- 进入页面:在订单支付成功页单击“返回我的云商店”,或在云商店首页单击“买家中心”,进入到“我的云商店>已购买的服务”商品列表页。

- 查看资源详情:在已购买的服务列表中找到该商品的名称,单击右侧操作栏的“资源详情”,可查看商品的基本信息、应用的AppKey/AppSecret、已使用的调用次数等信息。

- 查看详情:单击“应用信息>接口信息”中“查看接口”的按钮,跳转到商品详情页查看。

- 调用接口:在商品详情页“API接口”区可查看接口URL;

- 用户可参考签名认证调用操作步骤、简单身份认证(AppCode)调用操作步骤进行接口调用;
- 也可单击“调试API”,跳转至APIG控制台页面进行在线接口调试。

- 使用服务:按照详情页应用信息中的使用指南进行使用,若使用指南描述不清晰,请根据商家信息中的联系方式,联系商家提供服务。

签名认证调用操作步骤
用户在客户端调用API时,需要使用签名密钥对请求内容进行签名计算,并将签名同步传输给服务器端进行签名验证。API网关提供的SDK内置了签名实现,用户只需要将签名密钥(AppKey/AppSecret)配置在SDK中,即可实现发起携带正确签名的请求。
- 下载SDK:用户可以在商品详情页,单击“SDK信息”进行下载所需的编程语言SDK;

- 修改调用接口的请求信息:用户根据商详页提供的在线请求示例,修改客户端的请求参数和签名密钥(AppKey/AppSecret);

- 发起请求:用户将调用的接口请求信息修改完成后,客户端发起请求即可。
简单身份认证(AppCode)调用操作步骤
- 获取AppCode:
- 修改调用接口的请求信息:用户根据商详页提供的在线请求示例,修改客户端的请求参数和AppCode;

- 发起请求:用户将调用的接口请求信息修改完成后,客户端发起请求即可。
- 如操作中出现使用AppCode调用API接口失败等问题,请参见API类商品使用常见问题查看具体操作提示;
- 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理;
- 目前商品详情页提供的在线示例仅支持:Java、Go、Python、C#、Curl等5种。


