版本比较

旧版本 2

changes.mady.by.user YesCaptcha ADMIN

保存于

比较

新版本 当前的

changes.mady.by.user YesCaptcha ADMIN

保存于

密钥

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

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

信息

只有目标网站使用了企业版reCaptcha，我们才能使用企业版接口去识别….

信息

搜索api.js、recaptcha关键词，链接中含有enterprise的一般为企业版

信息

与普通版 reCaptcha v3 基本操作相同

创建任务

通过 createTask方法 创建识别任务

...

To create a recognition task using the createTask method and obtain the recognition result using the getTaskResult method.

信息

We can only use the enterprise version API to recognize if the target website is using the enterprise version reCaptcha.

信息

Links that contain the keywords "api.js" and "recaptcha", and have "enterprise" in the URL, generally refer to the enterprise version.

信息

Operates similarly to regular reCaptcha v3

Get the Result

To obtain the recognition result using the getTaskResult method.

Request node：

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

请求地址： Request address： https://api.yescaptcha.com/createTaskgetTaskResult

请求格式：Request format：POST application/json

...

Object Structure

属性Parameter

类型Type

必须Required

说明Purpose

type

string

是Yes

说明

绝大多数企业版V3可以直接用普通版v3接口来过In most cases, enterprise version V3 can be passed using the regular version V3 API directly.

RecaptchaV3EnterpriseTask

状态
colourGreen
title20 POINTS

RecaptchaV3EnterpriseTaskM1

状态
colourGreen
title25 POINTS

RecaptchaV3EnterpriseTaskT1

状态
colourGreen
title40 POINTS

*如果上述类型无法通过您的网站，可以联系客服为您定制接口。If the above types cannot pass the verification for your website, you can contact customer service to customize an API for you.

websiteURL

string

是Yes

ReCaptcha 网页地址，一般固定值。🔗 如何找到websiteURL值The address of the ReCaptcha web page.Fixed value.🔗 How to find the value of websiteURL?

websiteKey

String

是Yes

ReCaptcha 网站密钥，固定值。🔗 如何找到websiteKey值The ReCaptcha website key. Fixed value.🔗 How to find the value of websiteKey?

pageAction

String

否

可以为空，但如果有值则必须正确，否则识别的结果无效。🔗 如何找到pageAction值

...

No

This value must be correct, otherwise the recognition result is invalid.🔗How to find the necessary parameters for Google reCaptcha

Request Example

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

...

Response Example

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

获取结果

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

...

Get the Result

To obtain the recognition result using the getTaskResult method.

Request node：

状态
colourGreen
title国际节点INTERNATIONAL NODE
https://api.yescaptcha.com
状态
colourGreen
title国内节点CHINA NODE
https://chinacn.yescaptcha.com

请求地址： Request address： https://api.yescaptcha.com/getTaskResult

请求格式：Request format：POST application/json

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

...

Based on the system load, you will receive the result within a time interval of 10s to 80s, with a timeout of 120 seconds.

Request Example

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

...

Response Result

参数

Parameters

类型

Type

说明

Purpose

errorId

Integer

错误提示：

Error message: 0 -

没有错误，1 - 有错误

No error, 1 - Error

errorCode

string

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

Error code.Check out🔗 errors list.

errorDescription

string

错误详细描述

Error description

status

String

processing -

正在识别中，请3秒后重试

task is not ready yet.
ready -

识别完成，在solution参数中找到结果

task complete, solution object can be found in solution property.

solution

Object

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

Task result data. Different for each type of task.

gRecaptchaResponse

string

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

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

...

Recognition result: The response value, which is used to make a POST or simulated submission to the target website.

The response value is for one-time use only and is valid for 120 seconds. We recommend using it within 60 seconds.🔗 How to pass Google reCaptcha using the API

Response Example

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

响应说明

...

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

...

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

...

Response Description

  • Recognition succeeded: If errorId = 0 and status is ready, the result is in the solution field.

  • Recognition in progress: If errorId = 0 and status is processing, please retry after 3 seconds.

  • Error occurred: If errorId > 0, please refer to errorDescription to learn more about the error message. 🔗 Error Types