版本比较

密钥

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。
说明

通过 createTask方法 创建识别任务,然后通过 getTaskResult 方法 获取识别结果

信息

与 reCaptcha V2 不同在于,V3是无感识别,V3需要增加 pageAction 字段值(非必填)

创建任务

通过 createTask方法 创建识别任务

请求节点:

状态
colourGreen
title国际节点
https://api.yescaptcha.com
状态
colourGreen
title国内节点
https://cn.yescaptcha.com

...

请求格式:POST application/json

对象结构

属性

类型

必须

说明

type

string

RecaptchaV3TaskProxyless

状态
colourGreen
title20 POINTS

RecaptchaV3TaskProxylessM1

状态
colourGreen
title25 POINTS

RecaptchaV3TaskProxylessM1S7

状态
colourGreen
title30 points
强制分值0.7

RecaptchaV3TaskProxylessT1

状态
colourGreen
title25 POINTS
无固定分值

*如果上述类型无法通过您的网站,可以联系客服为您定制接口。

websiteURL

string

ReCaptcha 网页地址,一般固定值。🔗 如何找到websiteURL值

websiteKey

String

ReCaptcha 网站密钥,固定值。🔗 如何找到websiteKey值

pageAction

String

此值必须正确,否则识别的结果无效。🔗 如何找到pageAction值

请求示例

代码块
languagejson
{
    "clientKey": "cc9c18d3e263515c2c072b36a7125eecc078618f",
    "task": {
        "websiteURL" : "https://www.toysrus.co.jp/member/CMmMemberForm.jsp",
        "websiteKey" : "6LdJXmobAAAAAFLNEpWqZrAXDr4I3l2lFyMLdqoM",
        "pageAction" : "homepage", // 非必填
        "type" : "RecaptchaV3TaskProxyless"
    }
}

响应示例

代码块
{
    "errorId": 0,
    "errorCode": "",
    "errorDescription": "",
    "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006" // 请记录此ID
}

获取结果

使用 getTaskResult 方法获取识别结果。

请求节点:

状态
colourGreen
title国际节点
https://api.yescaptcha.com
状态
colourGreen
title国内节点
https://china.yescaptcha.com

...

根据系统负载,您将在 10s 到 80s 的时间间隔内得到结果

请求示例

代码块
{
    "clientKey":"cc9c18d3e263515c2c072b36a7125eecc078618f3",
    "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006"
}

响应结果

参数

类型

说明

errorId

Integer

错误提示: 0 - 没有错误,1 - 有错误

errorCode

string

错误代码,🔗 点这里查看全部错误列表

errorDescription

string

错误详细描述

status

String

processing - 正在识别中,请3秒后重试
ready - 识别完成,在solution参数中找到结果

solution

Object

识别结果,不同类型的任务结果会有所区别。

gRecaptchaResponse

string

识别结果:response值,用于POST或模拟提交给目标网站。

一次性使用,有效期120s,建议在60s内使用。🔗 了解如何使用response通过验证

响应示例

代码块
languagejson
{
    "errorId": 0,
    "errorCode": null,
    "errorDescription": null,
    "solution": {
        "gRecaptchaResponse": "03AGdBq25SxXT-pmSeBXjzScW-EiocHwwpwqtk1QXlJnGnU......"
    },
    "status": "ready"
}

...

  • 识别成功:当errorId等于0 并且status等于 ready,结果在solution里面。

  • 正在识别中:当errorId等于0 并且status等于 processing,请3秒后重试。

  • 出错了:当errorId 大于0,请根据errorDescription了解出错误信息 🔗 全部错误说明

...

拓展:

reCaptcha其他type可选(使用以下type不需要另外指定minScore)

...