Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

Version 1 Current »

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

创建任务

通过以下方法创建任务

请求host： https://api.ez-captcha.com

请求api： https://api.ez-captcha.com/createTask

请求format：POST application/json

参数

参数

类型

是否必须

描述

clientKey

string

yes

你的clientkey

type

string

yes

CloudFlareTurnstileTask

websiteURL

string

yes

网站url

websiteKey

string

yes

网站key

rqData

Object

optional

Turnstile 额外参数 (参考文档：Document)

rqData.mode

string

optional

Turnstile元素的data-action属性的值（如果存在）。

rqData.metadataAction

string

optional

Turnstile元素的data-action属性的值（如果存在）。

rqData.metadataCdata

string

optional

Turnstile元素的data-action属性的值（如果存在）。

示例 

POST https://api.ez-captcha.com/createTask

Content-Type: application/json

{
    "clientKey": "cc9c18d3e263515c2c072b36a7125eecc078618f",
    "task": {
        "websiteURL": "https://xxx.com",
        "type": "CloudFlareTurnstileTask",
        "websiteKey": "xxxx",
        "rqData":{                     //可选
            "mode":"flexible",
            "metadataAction":"signup",
            "metadataCdata":""
        },
    }
}

返回示例

{
    "errorId": 0,
    "errorCode": "",
    "errorDescription": "",
    "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006" // Please save this ID for next step
}

获取结果

使用 getTaskResult 方法获取结果

请求 host： https://api.ez-captcha.com

请求 api： https://api.ez-captcha.com/getTaskResult

请求 format：POST application/json

Request Example

POST https://api.ez-captcha.com/getTaskResult

Content-Type: application/json
 
{
    "clientKey":"YOUR_API_KEY",
    "taskId": "TASKID OF CREATETASK" //ID created by createTask method
}

返回参数

参数

类型

描述

errorId

Integer

错误提示： 0 - 没有错误，1 - 有错误

errorCode

string

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

errorDescription

string

错误详细描述

status

String

processing - 正在识别中，请3秒后重试
ready - 识别完成，在solution参数中找到结果

solution

Object

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

返回示例

{
    "errorId": 0,
    "errorCode": null,
    "errorDescription": null,
    "solution": {
        {"header": {}, "token": "0.alU6fkxnt1TwF7lTlYWWdu0o80HW-4unnp..."}
    },
    "status": "ready"
}

响应说明

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

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

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

  • No labels