← Back to Yizhou ☾
Authentication
Send your API key in the request header:
X-API-Key: YOUR_API_KEY
Get a free key at /en/start . Trial: 10 key checks and 3 CID. Keys are personal; do not share them.
1. Key validation (sync)
POST https://yizhouruanjian.com/api/v1/check
Content-Type: application/json
X-API-Key: YOUR_API_KEY
{"keys":["XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"]}
Up to 50 keys per request. Successful checks are charged; failed checks are not.
{"ok":true,"used":1,"credits_left":9,
"results":[{"key":"...","ok":true,"cached":false,
"result":{"info":{"activation_remaining":"..."}}}]}
2. Key validation (async batch)
POST https://yizhouruanjian.com/api/v1/check/jobs
{"keys":["...","..."]}
→ {"ok":true,"job_id":"...","total":2}
GET https://yizhouruanjian.com/api/v1/check/jobs/{job_id}
→ {"ok":true,"status":"done","results":[...]}
3. CID (single)
POST https://yizhouruanjian.com/cid/api
Content-Type: application/json
X-API-Key: YOUR_API_KEY
{"iid":"214006639597722177401340124218544353779142086799090595601656885"}
{"ok":true,"cid":"165704-...","groups":["..."],"cached":false}
A successful, uncached CID is charged once. Repeated requests for the same IID within 10 minutes are cached.
4. CID (batch)
POST https://yizhouruanjian.com/api/v1/cid/batch
{"iids":["...","..."]}
→ {"ok":true,"used":2,"credits_left":1,"results":[...]}
Up to 20 installation IDs per request.
5. Key OCR
POST https://yizhouruanjian.com/api/v1/key/ocr
{"image":"data:image/png;base64,..."}
→ {"ok":true,"keys":["XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"]}
Currently free of charge. Do not upload screenshots containing account or order data.
Errors & limits
400 invalid parameters
401/403 invalid or disabled API key
402 insufficient credits
429 rate limited
500 temporary service error, retry later
Rate limits: 60 requests/min and 3,000 keys/hour per account. CID: 20/hour per IP, batch 60/hour. Failed checks are not charged.
Scope
Read-only validation and confirmation IDs only. No activation, no key consumption, no account passwords. Not affiliated with or endorsed by Microsoft.