PRODUCT TEST WORKSPACE

Yidun Captcha

Captcha verification product

YIDUN_NE_CAPTCHA

02 / REQUEST

Request preview

POST /api/validator/create.cgi

{
  "productCode" : "YIDUN_NE_CAPTCHA",
  "adapter" : {
    "websiteURL" : "https://example.com/register",
    "websiteKey" : "YOUR_WEBSITEKEY"
  }
}

03 / RESULT

Response example

EXAMPLE

Task ID —

{
  "code" : 0,
  "msg" : "Success",
  "data" : {
    "taskId" : "11111111-1111-4111-8111-111111111111",
    "productCode" : "YIDUN_NE_CAPTCHA",
    "state" : "SUCCEEDED",
    "solution" : {
      "token" : "EXAMPLE_TOKEN"
    }
  }
}

Illustrative response; not a live task result. Replace all request placeholders before submitting.

Read data.solution after state becomes SUCCEEDED. The solution fields depend on the product; other states may return an empty object.

04 / API REFERENCE

Yidun Captcha · API

For task creation and queries, send the API key in the apiKey HTTP header. JSON request bodies contain business parameters only.

Content-Type: application/json
apiKey: YOUR_API_KEY

Result and application

TOKEN

Apply solution.token through this product integration, not an unrelated CAPTCHA field. Follow the target integration for submission and preserve any required returned User-Agent. A token alone does not establish target acceptance.

Conditional workflows

HTTP submission HTTP_SUBMIT
Apply a result in the browser BROWSER_RESULT

Requirements

Keep websiteURL/websiteKey for existing basic integrations. Where the target uses Enterprise parameters, capture yidunGetLib, yidunApiServerSubdomain, challenge, hcg and numeric hct from that current flow rather than inventing them. Custom server subdomains exclude the https:// prefix.
Prefer the product-specific (native) CAPTCHA integration over generic GRID. Identify the actual product/version and read its schema/guide before choosing. Use HTTP_SUBMIT when the target supports it, otherwise BROWSER_RESULT when the browser can apply the native result. Image grids on screen do not by themselves mean the product is GRID. Collect real inputs; missing inputs are a blocker, not permission to guess.
Apply a native result through the matching target integration: fill the expected token response field/callback, or use the returned challenge identifier and proof/answer fields together where that product requires them. Preserve the target session and bindings. Do not mix old and new challenge fields, replace only a picture, or assume the solver issues an unrelated transferable challenge/answer pair.
Collect fresh values from the same target/challenge. Respect product-specific hostname, action, challenge/session, IP, User-Agent and expiry requirements; these are not universally interchangeable. Apply returned cookies only to their matching domains.
Examples are placeholders, not runnable challenges. Documented result fields are not proof of target acceptance or a live availability test. Do not send unsupported fields.
SUCCEEDED means a solver result is available. Separately confirm that the target accepts the challenge and that the requested business operation completes. The solver cannot observe those two outcomes.

Input sources

Field	Input sources
`websiteURL`	Read from the actual target page, widget configuration or documented integration. Identify the precise product/version; placeholders and keys from another site cannot be substituted.
`websiteKey`	Read from the actual target page, widget configuration or documented integration. Identify the precise product/version; placeholders and keys from another site cannot be substituted.
`userAgent`	Actual browser User-Agent from the matching target session.
`yidunGetLib`	Actual yidunGetLib from the matching current Yidun initialization/network context; omit when unused by that target.
`yidunApiServerSubdomain`	Actual yidunApiServerSubdomain from the matching current Yidun initialization/network context; omit when unused by that target.
`challenge`	Actual challenge from the matching current Yidun initialization/network context; omit when unused by that target.
`hcg`	Actual hcg from the matching current Yidun initialization/network context; omit when unused by that target.
`hct`	Numeric Enterprise timestamp identifier from the same target request; not a string or your local clock.
`proxyType`	Proxy protocol: http, socks4 or socks5; use the same actual egress as the target session when bound.
`proxyAddress`	Reachable proxy hostname or IP without scheme, credentials or port.
`proxyLogin`	Optional proxy authentication username. Provide username and password together.
`proxyPassword`	Optional password for that same proxy, paired with proxyLogin.
`proxyPort`	Proxy TCP port, integer 1 to 65535.

Request example

POST /api/validator/create.cgi · JSONC

{
"productCode": "YIDUN_NE_CAPTCHA", // Product code matching the adapter parameters.
"adapter": { // Product-specific parameter object.
"websiteURL": "https://example.com/register", // Full URL of the page containing the challenge.
"websiteKey": "YOUR_WEBSITEKEY", // Public site key from the target page.
"userAgent": "YOUR_BROWSER_USER_AGENT", // Actual browser User-Agent from the matching target session.
"yidunGetLib": "YOUR_YIDUNGETLIB", // Actual yidunGetLib from the matching current Yidun initialization/network context; omit when unused by that target.
"yidunApiServerSubdomain": "YOUR_YIDUNAPISERVERSUBDOMAIN", // Actual yidunApiServerSubdomain from the matching current Yidun initialization/network context; omit when unused by that target.
"challenge": "YOUR_CHALLENGE", // Actual challenge from the matching current Yidun initialization/network context; omit when unused by that target.
"hcg": "YOUR_HCG", // Actual hcg from the matching current Yidun initialization/network context; omit when unused by that target.
"hct": 1779358333191, // Numeric Enterprise timestamp identifier from the same target request; not a string or your local clock.
"proxyType": "http", // Proxy protocol: http, socks4 or socks5; use the same actual egress as the target session when bound.
"proxyAddress": "YOUR_PROXY_HOST", // Reachable proxy hostname or IP without scheme, credentials or port.
"proxyLogin": "YOUR_PROXYLOGIN", // Optional proxy authentication username. Provide username and password together.
"proxyPassword": "YOUR_PROXYPASSWORD", // Optional password for that same proxy, paired with proxyLogin.
"proxyPort": 8080 // Proxy TCP port, integer 1 to 65535.
}
}

Request headers: apiKey: YOUR_API_KEY

Comments explain the fields. Copy produces valid JSON without comments.

Response example

POST /api/validator/query.cgi · JSONC

{
  "code": 0, // Business result code: 0 means success; other values indicate an error.
  "msg": "Success", // Result message; may be empty on success.
  "data": { // Response data; may be null on an error.
    "taskId": "11111111-1111-4111-8111-111111111111", // Task ID returned by task creation.
    "productCode": "YIDUN_NE_CAPTCHA", // Product code matching the adapter parameters.
    "state": "SUCCEEDED", // Task state: CREATED, SUBMITTING, PROCESSING, SUCCEEDED, FAILED or EXPIRED.
    "solution": { // Product answer when SUCCEEDED; empty while processing or on failure.
      "token": "EXAMPLE_TOKEN" // Verification token to submit to the target website.
    }
  }
}

Creating a task returns its ID and initial state. Query the result or use WebSocket to receive the completed answer shown below.

Request parameters

Field	Type	Required	Description
`productCode`	string	Yes	Product code matching the adapter parameters.
`adapter`	object	Yes	Product-specific parameter object.
`adapter.websiteURL`	string	Yes	Full URL of the page containing the challenge.
`adapter.websiteKey`	string	Yes	Public site key from the target page.
`adapter.userAgent`	string	No	Actual browser User-Agent from the matching target session.
`adapter.yidunGetLib`	string	No	Actual yidunGetLib from the matching current Yidun initialization/network context; omit when unused by that target.
`adapter.yidunApiServerSubdomain`	string	No	Actual yidunApiServerSubdomain from the matching current Yidun initialization/network context; omit when unused by that target.
`adapter.challenge`	string	No	Actual challenge from the matching current Yidun initialization/network context; omit when unused by that target.
`adapter.hcg`	string	No	Actual hcg from the matching current Yidun initialization/network context; omit when unused by that target.
`adapter.hct`	integer	No	Numeric Enterprise timestamp identifier from the same target request; not a string or your local clock.
`adapter.proxyType`	string	No	Proxy protocol: http, socks4 or socks5; use the same actual egress as the target session when bound.
`adapter.proxyAddress`	string	No	Reachable proxy hostname or IP without scheme, credentials or port.
`adapter.proxyLogin`	string	No	Optional proxy authentication username. Provide username and password together.
`adapter.proxyPassword`	string	No	Optional password for that same proxy, paired with proxyLogin.
`adapter.proxyPort`	integer	No	Proxy TCP port, integer 1 to 65535.

Response parameters

Field	Type	Description
`code`	integer	Business result code: 0 means success; other values indicate an error.
`msg`	string	Result message; may be empty on success.
`data`	object \| null	Response data; may be null on an error.
`data.taskId`	string	Task ID returned by task creation.
`data.productCode`	string	Product code matching the adapter parameters.
`data.state`	string	Task state: CREATED, SUBMITTING, PROCESSING, SUCCEEDED, FAILED or EXPIRED.
`data.solution`	object	Product answer when SUCCEEDED; empty while processing or on failure.
`data.failure`	object \| omitted	Public diagnosis for FAILED/EXPIRED only; no raw provider messages. Follow the failure handling guide.
`data.failure.code`	string	Failure code
`data.failure.nextAction`	string	Next action
`data.solution.token`	string	Verification token to submit to the target website.

Responses

HTTP business responses contain code, msg and data; code 0 means success. WebSocket uses a separate message structure.

-1317: Invalid API key.
-1100 / -1101: Invalid or missing request parameters.
-1401: Insufficient balance. Add funds before creating a task.
-1400 / -1001: System or task creation error.

API documentation

Yidun Captcha

Create task

Request preview

Response example

Yidun Captcha · API

Request example

Response example

Request parameters

Response parameters

Responses