全部产品
云市场

调用方式

更新时间:2019-07-19 17:57:43

人机验证服务接口调用是向人机验证服务API的服务端地址发送HTTP GET请求,并按照接口说明在请求中加入相应请求参数,调用后系统会返回处理结果。请求及返回结果都使用UTF-8字符集进行编码。

请求结构

人机验证服务的API是RPC风格,您可以通过发送HTTPS GET请求调用人机验证服务API。

说明:为了获得更高的安全性,人机验证服务仅支持通过HTTPS通道进行请求通信。

其请求结构如下:

  1. https://Endpoint/?Action=xx&Parameters

其中:

  • Endpoint:负载均衡API的服务接入地址为afs.aliyuncs.com。
  • Action:要执行的操作,如使用AuthenticateSig验证前端页面获取到的签名串是否由验证码服务端颁发。
  • Version:要使用的API版本,人机验证服务的API版本是2018-01-12。
  • Parameters:请求参数,每个参数之间用“&”分隔。

请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息,详情参见公共参数

下面是一个调用AuthenticateSig接口验证前端页面获取到的签名串是否由验证码服务端颁发的示例:

说明:为了便于您查看,本文档中的示例都进行了格式化处理。

  1. http://afs.aliyuncs.com/?Action=AuthenticateSig
  2. &SessionId=13211111111
  3. &Scene=xxx
  4. &Token=xxx
  5. &Sig=1
  6. &AppKey=xxx
  7. &RemoteIp=xxx
  8. &Format=xml
  9. &Version=2018-01-12
  10. &Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
  11. &SignatureMethod=HMAC-SHA1
  12. &SignatureNonce=15215528852396
  13. &SignatureVersion=1.0
  14. &AccessKeyId=key-test
  15. &Timestamp=2014-10-10T12:00:00Z

API授权

为了确保您的账号安全,建议您使用子账号的身份凭证调用API。如果您使用RAM账号调用人机验证服务API,您需要为该RAM账号创建、附加相应的授权策略。

API签名

人机验证服务会对每个API请求进行身份验证,提交请求时需要在请求中包含签名(Signature)信息。

签名计算过程参见RPC API签名

人机验证服务通过使用AccessKey ID和AccessKey Secret进行对称加密的方法来验证请求的发送者身份。AccessKey是为阿里云账号和RAM用户发布的一种身份凭证(类似于用户的登录密码),其中AccessKey ID 用于标识访问者的身份,AccessKey Secret是用于加密签名字符串和服务器端验证签名字符串的密钥,必须严格保密。

RPC API需按如下格式在请求中增加签名(Signature):

  1. https://endpoint/?SignatureVersion=1.0&SignatureMethod=HMAC-SHA1&Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D&SignatureNonce=3ee8c1b8-83d3-44af-a94f-4e0ad82fd6cf

以AuthenticateSig为例,假设AccessKey ID是testid, AccessKey Secret是testsecret,则签名前的请求URL如下:

  1. https://afs.aliyuncs.com/?Action=AuthenticateSig
  2. &SessionId=13211111111
  3. &Scene=xxx
  4. &Token=xxx
  5. &Sig=1
  6. &AppKey=xxx
  7. &RemoteIp=xxx
  8. &Format=xml
  9. &Version=2018-01-12
  10. &SignatureMethod=HMAC-SHA1
  11. &SignatureNonce=15215528852396
  12. &SignatureVersion=1.0
  13. &AccessKeyId=testid
  14. &Timestamp=2014-10-10T12:00:00Z

完成以下步骤计算签名:

  1. 使用请求参数创建待签名字符串:

    1. GET&%2F&AccessKeyId%3Dtestid&Action%3DAuthenticateSig&SessionId%3D13211111111&Scene%3Dxxx&Token%3Dxxx&Sig%3D1&AppKey%3Dxxx&RemoteIp%3Dxxx&Format%3DXML&SignatureMethod%3DHMAC-SHA1&SignatureNonce%3D15215528852396&SignatureVersion%3D1.0&TimeStamp%3D2014-10-10T12%253A00%253A00Z&Version%3D2018-01-12
  2. 计算待签名的HMAC的值。

    在AccessKey Secret后添加一个“&”作为计算HMAC值的key。本示例中的key为testsecret&。

    1. CT9X0VtwR86fNWSnsc6v8YGOjuE=
  3. 将签名加到请求参数中:

    1. https://afs.aliyuncs.com/?Action=AuthenticateSig
    2. &SessionId=13211111111
    3. &Scene=xxx
    4. &Token=xxx
    5. &Sig=1
    6. &AppKey=xxx
    7. &RemoteIp=xxx
    8. &Format=xml
    9. &Version=2018-01-12
    10. &SignatureMethod=HMAC-SHA1
    11. &SignatureNonce=15215528852396
    12. &SignatureVersion=1.0
    13. &AccessKeyId=testid
    14. &Timestamp=2014-10-10T12:00:00Z
    15. &Signature=CT9X0VtwR86fNWSnsc6v8YGOjuE%3D