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 Page History

« Previous Version 2 Next »

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

CloudFlare5STask

websiteURL

string

yes

网站url

proxy

string

yes

使用的代理，如http://username:password@ip:port

rqData

Object

optional

如果添加此字段，请求将会以Post的方式发送，如

rqData: { "name": "value" }

示例

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

Content-Type: application/json

{
    "clientKey": "YourClientKey",
    "task": {
        "websiteURL": "https://xxx.com",
        "type": "CloudFlare5STask",
        "proxy": "http://username:password@ip:port",
        "rqData":{                   //可选
            "name":"value",
        },

    }
}

返回示例

{
    "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

请求示例

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": {
          "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7", 
          "accept-encoding": "gzip, deflate, br, zstd", 
          ...
          "user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36"
        }, 
        "cookies": {
          "cf_clearance": "suAu.vzSYU4etZ2lc1FVhVhoAtKrKjHvbLn1.qY8m0E-1736763580-1.2.1.1-NM03fWRNYkN_gYFO1n1nlzwe9MtiNmm9YIz7ujq_Jmh_FyJvg2YA7ImuXyD_9ouZ2XYy.G73Gude_Qpzx04subKCPhHeaRr1qTKicxeGV9p6GhU_z75.6OTi.FlDFXe7ogCYwyPMn3xZKzFkzpDqpHBUv5uq40LF7Z07PIEPizwE8XZuhlVBhVkgulsWu4QCkStR95HbJxGNmKOf0h2PZSJPSStyCV5XwpmAIuZy3Zhfm46r4gDAbh7q.Isx_nMjpo6WCGYrpQrFHAfZQWd6NshmfxQyVJmItilb1p2evZrt3aVQOhmaTpKOzM4E5Rhtc8i2xYtm_hUk9ToGQm_7_g", 
          ...
        }, 
        "body": "<!DOCTYPE html>\n<html lang="en">\n<head>\n   ..."
      }
    },
    "status": "ready"
}

响应说明

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

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

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

  • No labels