验证码识别服务 API 文档

一站式验证码识别平台，支持多种验证码类型，提供简洁统一的 REST API 接口。

支持的验证码类型

🚀 快速开始

完整示例

import requests, base64

API = "http://localhost:1818"
KEY = "cap_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

# 读取验证码图片并Base64编码
with open("captcha.png", "rb") as f:
    img_b64 = base64.b64encode(f.read()).decode()

# 发起识别
resp = requests.post(f"{API}/api/solve", json={
    "type_code": "ddddocr_ocr",
    "data": {"image": img_b64}
}, headers={"X-API-Key": KEY})

print(resp.json())
# {"success": true, "result": {"text": "a8Kx"}}

# 识别验证码
curl -X POST http://localhost:1818/api/solve \
  -H "Content-Type: application/json" \
  -H "X-API-Key: cap_xxxxxxxx" \
  -d '{"type_code":"ddddocr_ocr","data":{"image":"BASE64..."}}'

const API = "http://localhost:1818";
const KEY = "cap_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";

// 识别验证码
const resp = await fetch(`${API}/api/solve`, {
    method: "POST",
    headers: {
        "Content-Type": "application/json",
        "X-API-Key": KEY
    },
    body: JSON.stringify({
        type_code: "ddddocr_ocr",
        data: { image: imgBase64 }
    })
});
const result = await resp.json();
console.log(result);

🔑 认证方式

所有需要认证的 API 端点都需要在请求头中携带 X-API-Key：

X-API-Key: cap_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

也可以通过 URL 参数传递（不推荐）：

GET /api/user/info?api_key=cap_xxxxxxxx

验证码识别

请求参数

data 字段说明（按类型）

请求示例

POST /api/solve HTTP/1.1
Host: localhost:1818
Content-Type: application/json
X-API-Key: cap_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

{
    "type_code": "ddddocr_ocr",
    "data": {
        "image": "iVBORw0KGgoAAAANSUhEUgAA..."  // Base64编码的图片
    }
}

响应示例

{
    "success": true,
    "result": {
        "text": "a8Kx"
    }
}

验证码类型列表

请求示例

GET /api/types HTTP/1.1
Host: localhost:1818

响应示例

{
    "success": true,
    "data": [
        {
            "id": 1,
            "name": "文字OCR识别",
            "code": "ddddocr_ocr",
            "engine": "ddddocr",
            "pricing": {"normal": 2, "vip": 1}
        }
    ]
}

用户登录

请求参数

请求示例

POST /api/login HTTP/1.1
Host: localhost:1818
Content-Type: application/json

{
    "username": "myuser",
    "password": "mypassword"
}

响应示例

{
    "success": true,
    "data": {
        "id": 2,
        "username": "myuser",
        "api_key": "cap_a1b2c3d4..."
    }
}

个人信息

请求示例

GET /api/user/info HTTP/1.1
Host: localhost:1818
X-API-Key: cap_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

响应示例

{
    "success": true,
    "data": {
        "id": 2,
        "username": "myuser",
        "email": "user@example.com",
        "role": "normal",
        "balance": 88,
        "api_key": "cap_a1b2c3d4...",
        "active_package": {
            "package_name": "月卡",
            "expires_at": "2026-03-14T20:00:00"
        }
    }
}

重置 API Key

请求示例

POST /api/user/reset-key HTTP/1.1
Host: localhost:1818
X-API-Key: cap_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

响应示例

{
    "success": true,
    "new_api_key": "cap_e5f6g7h8..."
}

错误码参考

错误响应格式

{
    "success": false,
    "error": "错误描述信息"
}