Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Note

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

Info

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

创建任务

通过 createTask方法 创建识别任务

请求节点: https://api.ez-captcha.com

...

请求格式:POST application/json

任务类型

对于ReCaptcha V3的解决方案,我们提供的任务类型如下:

任务类型

描述

价格

ReCaptchaV3TaskProxyless

reCaptcha V3解决方案,使用服务器内置代理

Status
colourBlue
title8 POINTS

ReCaptchaV3TaskProxylessS9

reCaptcha V3高分值解决方案,使用服务器内置代理并使得返回的token分数至少为0.9

Status
colourBlue
title15 POINTS

ReCaptchaV3EnterpriseTaskProxyless

reCaptcha V3Enterprise解决方案,使用服务器内置代理

Status
colourPurple
title20 POINTS

对象结构

属性

类型

必须

说明

clientKey

string

帐户密钥,可以在个人中心找到

task

object

任务参数对象,详情为表格以下几项

type

string

任务类型,如 ReCaptchaV3TaskProxyless

websiteURL

string

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

websiteKey

String

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

isInvisible

Bool

对于reCaptcha V3类型, 该参数一般都为true,如果用户不提供,则默认自动设置为true

pageAction

String

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

请求示例

Code Block
POST https://api.ez-captcha.com/createTask
Host: api.ez-captcha.com
Content-Type: application/json
{
  "clientKey":"yourapiKey",
    "task":
        {
           "type":"RecaptchaV3TaskProxyless",
           "websiteURL":"https://recaptcha-demo.appspot.com/recaptcha-v3-request-scores.php",
           "websiteKey":"6LdyC2cUAAAAACGuDKpXeDorzUDWXmdqeg-xy696",
           "pageAction": "examples/v3scores",
           "isInvisible": true
        }
}

响应示例

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

获取结果

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

请求节点: https://api.ez-captcha.com

...

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

请求示例

Code Block
{
    "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通过验证

响应示例

Code Block
{
    "errorId": 0,
    "errorCode": null,
    "errorDescription": null,
    "solution": {
        "gRecaptchaResponse": "03AGdBq25SxXT-pmSeBXjzScW-EiocHwwpwqtk1QXlJnGnU......"
    },
    "status": "ready"
}

...