API交付类商品使用指导
更新时间:2023-10-11
API的调试
在商品详情页,可以查看API商品内的API列表及详情。在购买商品后,点击“去调试”按钮,可以对API进行在线调试。
API的调用
API方式交付在购买后,可通过AppCode或API签名的方式调用。两种调用方式都需要在请求中添加名为X-Bce-Signature的请求头(Header),该请求头的值AppCode或API签名的方式不同。
签名中需要用到的AppCode或AccessKey/AppSecret可在百度智能云千帆AI原生应用商店的已购服务列表中已购买的API商品的订单详情页获得。
使用AppCode方式调用
使用AppCode方式调用API较为简单,只要将AppCode以特定的格式放置于X-Bce-Signature请求头中即可。具体格式为"AppCode/" + AppCode值。如AppCode值为6f4ac66971454093bcceb34521bb541e,那么X-Bce-Signature的值为AppCode/6f4ac66971454093bcceb34521bb541e。
示例:
GET /test HTTP/1.1
Host: test.api.bdymkt.com
X-Bce-Signature: AppCode/6f4ac66971454093bcceb34521bb541e
由于AppCode在请求中明文出现,因此任何截获请求的人均可发送同样的请求,使用时请注意评估由此带来的安全风险。如果需要保证更高的安全性,建议使用API签名的方式调用。AppCode可以进行重置。重置后旧的AppCode将失效。
使用API签名方式调用
API签名方式以AccessKey、AppSecret及请求信息进行签名,并将签名值放置于X-Bce-Signature请求头中。该签名方式的具体算法详见API网关 -调用API。
示例:
GET /test HTTP/1.1
Host: test.api.bdymkt.com
X-Bce-Signature: bce-auth-v1/927ee1440e974eb0aa5bb8f448078676/2019-01-01T00:00:00Z/1800/content-type;host/2987fdac91c927dbdc59d43b01131e3b9fb9eb29813422c8e0d76bc3c124826b