Versions Compared

Key

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

...

属性

类型

必须

说明

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
        }
}

...

参数

类型

说明

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"
}

...

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

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

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