Request host: https://api.ez-captcha.com
Request api: https://api.ez-captcha.com/createTask
Request format:POST
application/json
Task Type
Parameters | Description | Price |
---|---|---|
ReCaptchaV2TaskProxyless | reCaptcha V2 solution, using server built-in proxy | 6 POINTS |
ReCaptchaV2TaskProxylessS9 | reCaptcha V2 High-scoring solutions, use the server's built-in proxy and make the returned token score at least 0.9 | 12 POINTS |
RecaptchaV2EnterpriseTaskProxyless | reCaptcha V2 Enterprise solution, using server built-in proxy | 18 POINTS |
ReCaptchaV2STaskProxyless | reCaptcha V2 with s parameter solution, using server built-in proxy | 15 POINTS |
RecaptchaV2SEnterpriseTaskProxyless | reCaptcha V2 Enterprise with s parameter solution, using server built-in proxy | 30 POINTS |
ReCaptchaV3TaskProxyless | reCaptcha V3 solution, using server built-in proxy | 8 POINTS |
ReCaptchaV3TaskProxylessS9 | reCaptcha V3 High-scoring solutions, use the server's built-in proxy and make the returned token score at least 0.9 | 15 POINTS |
ReCaptchaV3EnterpriseTaskProxyless | reCaptcha V3Enterprise solution, using server built-in proxy | 18 POINTS |
Request Parameters
Parameters | Type | Required | Description |
---|---|---|---|
clientKey | string | true | Account client key, which can be found in the personal center |
task | object | true | The task parameter object, the details are the following items in this table |
type | string | true | Task type, such as ReCaptchaV2TaskProxyless |
websiteURL | string | true | Website url using ReCaptcha, usually a fixed value |
websiteKey | string | true | ReCaptcha site key, a fixed value |
isInvisible | Bool | false | For the reCaptcha V2 type, if it is an invisible type of reCaptchaV2, you need to add this parameter and set it to true. If this parameter is not filled, it defaults to false. For the reCaptcha V3 type, this parameter defaults to true |
pageAction | string | false | This parameter is only for reCaptcha V3 and generally needs to be filled in. If it is not filled in, an empty parameter will be used by default, which will greatly affect the token accuracy |
s | string | false | Only used to solve reCaptcha V2 with s parameter, including V2 and V2 Enterprise, you need to specify the type as ReCaptchaV2STaskProxyless or RecaptchaV2SEnterpriseTaskProxyless, find this parameter from the data packet returned from the website you are using and set it. |
Request Example
ReCaptcha V3
POST https://api.ez-captcha.com/createTask 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 } }
Response Data
Parameters | Type | Description |
---|---|---|
errorId | Integer | Error message: 0 - no error, 1 - error |
errorCode | string | Error Code |
errorDescription | string | Detailed error description |
taskId | string | Created task ID, use the getTaskResult interface to get the token result |
Response Example
{ "errorId": 0, "errorCode": "", "errorDescription": "", "taskId": "2376919c-1863-11ec-a012-94e6f7355a0b" // Please save this ID for the next step }