全部产品
阿里云办公

步骤 4:调用 API

更新时间:2017-08-29 16:55:34

您可以直接用 API 网关控制台为您提供的多语言调用示例来测试调用,可以自行编辑 HTTP(s) 请求来调用 API。关于签名方式,您可以参照API网关提供的SDK及样例

通过上述步骤,您已经获取了 API 定义文档、创建了 APP、建立了授权关系。

您可以调用 API 了。API 的请求步骤说明如下:

第一部分:请求

请求地址

  1. http://e710888d3ccb4638a723ff8d03837095-cn-qingdao.aliapi.com/demo/post

请求方法

  1. POST

请求体

  1. FormParam1=FormParamValue1&FormParam2=FormParamValue2
  2. //HTTP Request Body

请求头部

  1. Host: e710888d3ccb4638a723ff8d03837095-cn-qingdao.aliapi.com
  2. Date: Mon, 22 Aug 2016 11:21:04 GMT
  3. User-Agent: Apache-HttpClient/4.1.2 (java 1.6)
  4. Content-Type: application/x-www-form-urlencoded; charset=UTF-8
  5. //请求体类型,请根据实际请求体内容设置。
  6. Accept: application/json
  7. //请求响应体类型,部分 API 可以根据指定的响应类型来返回对应数据格式,建议手动指定此请求头,如果不设置,部分 HTTP 客户端会设置默认值 */*,导致签名错误。
  8. X-Ca-Request-Mode: debug
  9. //是否开启 Debug 模式,大小写不敏感,不设置默认关闭,一般 API 调试阶段可以打开此设置。
  10. X-Ca-Version: 1
  11. // API版本号,目前所有 API 仅支持版本号『1』,可以不设置此请求头,默认版本号为『1』。
  12. X-Ca-Signature-Headers: X-Ca-Request-Mode,X-Ca-Version,X-Ca-Stage,X-Ca-Key,X-Ca-Timestamp
  13. //参与签名的自定义请求头,服务端将根据此配置读取请求头进行签名,此处设置不包含 Content-Type、Accept、Content-MD5、Date 请求头,这些请求头已经包含在了基础的签名结构中,详情参照请求签名说明文档。
  14. X-Ca-Stage: RELEASE
  15. //请求 API的Stage,目前支持 TEST、PRE、RELEASE 三个 Stage,大小写不敏感,API 提供者可以选择发布到哪个 Stage,只有发布到指定 Stage 后 API 才可以调用,否则会提示 API 找不到或 Invalid Url。
  16. X-Ca-Key: 60022326
  17. //请求的 AppKey,请到 API 网关控制台生成,只有获得 API 授权后才可以调用,通过云市场等渠道购买的 API 默认已经给APP授过权,阿里云所有云产品共用一套 AppKey 体系,删除 ApppKey 请谨慎,避免影响到其他已经开通服务的云产品。
  18. X-Ca-Timestamp: 1471864864235
  19. //请求的时间戳,值为当前时间的毫秒数,也就是从1970年1月1日起至今的时间转换为毫秒,时间戳有效时间为15分钟。
  20. X-Ca-Nonce:b931bc77-645a-4299-b24b-f3669be577ac
  21. //请求唯一标识,15分钟内 AppKey+API+Nonce 不能重复,与时间戳结合使用才能起到防重放作用。
  22. X-Ca-Signature: FJleSrCYPGCU7dMlLTG+UD3Bc5Elh3TV3CWHtSKh1Ys=
  23. //请求签名。
  24. CustomHeader: CustomHeaderValue
  25. //自定义请求头,此处仅作为示例,实际请求中根据 API定义可以设置多个自定义请求头。

第二部分:响应

状态码

  1. 400
  2. //响应状态码,大于等于200小于300表示成功;大于等于400小于500为客户端错误;大于500为服务端错误。

响应头

  1. X-Ca-Request-Id: 7AD052CB-EE8B-4DFD-BBAF-EFB340E0A5AF
  2. //请求唯一 ID,请求一旦进入 API 网关应用后,API 网关就会生成请求 ID 并通过响应头返回给客户端,建议客户端与后端服务都记录此请求 ID,可用于问题排查与跟踪。
  3. X-Ca-Error-Message: Invalid Url
  4. // API网关返回的错误消息,当请求出现错误时 API 网关会通过响应头将错误消息返回给客户端。
  5. X-Ca-Debug-Info: {"ServiceLatency":0,"TotalLatency":2}
  6. //当打开 Debug 模式后会返回 Debug 信息,此信息后期可能会有变更,仅用做联调阶段参考。

您调用 API 时,无论使用 HTTP 还是 HTTPS 协议提交请求,都需要在请求中包含签名信息。详细加密签名的计算传递方式,请查看文档 请求签名说明文档

签名的计算 demo 请参照 API 网关控制台 SDK下载 页面的 SDK 示例。

若需要了解更多详情,请您查看 使用手册(调用 API)