版本比较

版本 旧版本 1 新版本 当前的
做出修改的是

YesCaptcha ADMIN

YesCaptcha ADMIN

保存于

密钥

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

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

信息

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

信息

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

警告

以下网站本接口暂时不能通过：

  1. https://store.steampowered.com/

  2. https://benefits.uc.pa.gov/

信息

企业V2目前通过较为困难，如果本接口不能通过验证，建议了解（有一定技术难度）

说明

STEAM无法通过此接口识别，请使用图像识别接口，或者使用基于图像识别接口开发的软件，价格可咨询客服。

创建任务

通过 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.

信息

It may be difficult to pass the enterprise v2 verification through this API at the moment. If you are having trouble passing the verification, I suggest exploring other methods, which may require some technical expertise.

  • ReCaptchaV2Classification: reCaptcha V2 image recognition

说明

This API may not be able to recognize STEAM verification. I recommend using an image recognition API or a software developed based on image recognition API. Please contact customer service for pricing information.

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

RecaptchaV2EnterpriseTaskProxyless

状态
colourGreen
title20 POINTS

RecaptchaV2EnterpriseTaskProxylessK1

状态
colourGreen
title25 POINTS
状态
colourPurple
titleCustomized type
状态
colour

Yellow

Purple
title

插件默认

contact US before use

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?

enterprisePayload

Object

否

附加参数s，可在在下方代码中找到：

No

The additional parameter "s" can be found in the code below:

代码块
grecaptcha.enterprise.render( render_div_id, {
		'sitekey': sitekey,
		'theme': 'dark',
		'callback': function(n){},
		's': "2JvUXHNTnZl1Jb6WEvbDyBMzrMTR7oQ78QRhBcG07rk9bpaAaE0LRq1ZeP5NYa0N...ugQA"
});

...

Request Example

代码块
languagejson
{
    "clientKey": "cc9c18d3e263515c2c072b36a7125eecc078618f",
    "task": {
		"websiteURL": "https://store.steampowered.com/",
		"websiteKey": "6LdIFr0ZAAAAAO3vz0O0OQrtAefzdJcWQM2TMYQH",
		"type": "RecaptchaV2EnterpriseTaskProxyless",
		"enterprisePayload": {
                "s": "2JvUXHNTnZl1Jb6WEvbDyBMzrMTR7oQ78QRhBcG07rk9bpaAaE0LRq1ZeP5NYa0N..."  
      }
    }
}

...

Response Example

代码块
{
    "errorId": 0,
    "errorCode": "",
    "errorDescription": "",
    "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006" // 请记录此IDPlease 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 到 120s 的时间间隔内得到结果

...

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