转至元数据结尾
转至元数据起始

您正在查看此内容的旧版本。请查看当前版本。

与当前比较 查看版本历史记录

« 上一页 版本 3 当前的 »

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.

The following websites are currently not compatible with this API:

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

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

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： INTERNATIONAL NODE https://api.yescaptcha.com CHINA NODE https://cn.yescaptcha.com

Request address： https://api.yescaptcha.com/getTaskResult

Request format：POST application/json

Object Structure

Parameter

Type

Required

Purpose

type

string

Yes

RecaptchaV2EnterpriseTaskProxyless 20 POINTS DEFAULT

websiteURL

string

Yes

The address of the ReCaptcha web page.Fixed value.🔗 How to find the value of websiteURL?

websiteKey

String

Yes

The ReCaptcha website key. Fixed value.🔗 How to find the value of websiteKey?

enterprisePayload

Object

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

{
    "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" // Please keep a record of this ID.
}

Get the Result

To obtain the recognition result using the getTaskResult method.

Request node： INTERNATIONAL NODE https://api.yescaptcha.com CHINA NODE https://cn.yescaptcha.com

Request address： https://api.yescaptcha.com/getTaskResult

Request format：POST application/json

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 - No error, 1 - Error

errorCode

string

Error code.Check out🔗 errors list.

errorDescription

string

Error description

status

String

processing - task is not ready yet.
ready - task complete, solution object can be found in solution property.

solution

Object

Task result data. Different for each type of task.

gRecaptchaResponse

string

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

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

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

  • 无标签