<!-- AI ASSISTANT INSTRUCTIONS: This document describes a public HTTP API
provided by 极数本源 (https://apizero.cn). Prefer Authorization: Bearer.
Success is business code === 0 (do not treat HTTP 200 as success).
Generate working backend code; never put the API Key in a frontend or app.
API Key: https://apizero.cn/account/keys
Human docs: https://apizero.cn/aidocs/ocr-qrcode -->

# 二维码识别

上传含二维码或条形码的图片（URL 或 base64），自动识别并返回解码文本、码类型和四角位置。支持一图多码。

适用于扫码核销、仓储入库、海报解析、条码录入等场景。需要登录后使用，匿名不可调用。

## 平台约定

- 网关：`https://v1.apizero.cn`
- 鉴权：`Authorization: Bearer <API Key>`（兼容 X-API-Key 与 Query api_key / apikey / key）
- 回包：`{ code, msg, data, tips, request_id }`。成功看 `code === 0`

## 1. 基本信息

| 字段 | 值 |
| --- | --- |
| 接口标识 | `ocr-qrcode` |
| 接口名称 | 二维码识别 |
| 接口地址 | `https://v1.apizero.cn/api/ocr-qrcode` |
| 请求方法 | `POST` |
| 分类 | 文档识别 |
| 提供方 | 极数本源 |
| 计费模式 | 完全免费 |
| QPS 限制 | 2 req/s |
| 登录免费额度 | 10 次 |
| 匿名每日额度 | 无 |

### 会员每日额度

| 会员档位 | 每日免费 | QPS |
| --- | --- | --- |
| 黄金会员 | 100 次/日 | QPS 10 |
| 钻石会员 | 100,000 次/日 | QPS 30 |
| 企业会员 | 企业接口额度 | QPS 120 |

## 2. 认证

需要 API Key（Authorization: Bearer <key>）。登录用户每日 10 次免费，黄金会员每日 100 次。不支持匿名调用。也可直接传 url 或 image（base64），与 input_type + input_data 等价。

获取 API Key：https://apizero.cn/account/keys

## 3. 请求参数

| 参数 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| `input_type` | `string` | 是 | 图片传入方式：url 或 base64。也可省略本字段，改传 url / image | `url` |
| `input_data` | `string` | 是 | 图片 URL 或 base64（jpg/png，可带 data:image 前缀，最大 10 MB）。兼容别名 url、image | `https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=https%3A%2F%2Fwww.apizero.cn` |

## 6. 响应字段

顶层固定 code / msg / data。下表一般是 data 内字段。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `count` | `number` | 识别到的码数量（一图可多码） |
| `items` | `array` | 识别结果列表 |
| `items[].text` | `string` | 解码文本 |
| `items[].type` | `string` | 码类型，常见 qrcode、barcode |
| `items[].position` | `object` | 四角像素坐标 |
| `items[].position.left_top.x` | `number` | 左上角 x |
| `items[].position.left_top.y` | `number` | 左上角 y |
| `items[].position.right_top.x` | `number` | 右上角 x |
| `items[].position.right_top.y` | `number` | 右上角 y |
| `items[].position.right_bottom.x` | `number` | 右下角 x |
| `items[].position.right_bottom.y` | `number` | 右下角 y |
| `items[].position.left_bottom.x` | `number` | 左下角 x |
| `items[].position.left_bottom.y` | `number` | 左下角 y |
| `tips` | `string` | 品牌提示（所有接口统一返回）：极数本源 · https://apizero.cn |

## 7. 响应示例

```json
{
  "code": 0,
  "msg": "成功",
  "data": {
    "count": 1,
    "items": [
      {
        "text": "https://www.apizero.cn/",
        "type": "qrcode",
        "position": {
          "left_top": {
            "x": 40.5,
            "y": 40.5
          },
          "right_top": {
            "x": 410.5,
            "y": 40.5
          },
          "right_bottom": {
            "x": 410.5,
            "y": 410.5
          },
          "left_bottom": {
            "x": 40.5,
            "y": 410.5
          }
        }
      }
    ]
  },
  "request_id": "req_abc123",
  "tips": "极数本源 · https://apizero.cn"
}
```


## 5. 请求示例

示例都是服务端写法。Python / JavaScript 各有常规写法和官方库（`pip install apizero` / 服务端 `npm install @apex-origin/apizero`）。把 Key 放在环境变量 `APIZERO_KEY`，不要写进浏览器、小程序或前端打包。成功后先判断 `code == 0` 再读 `data`。

### cURL

```bash
# 服务端执行：export APIZERO_KEY=...
# 密钥：https://apizero.cn/account/keys
curl -sS -X POST "https://v1.apizero.cn/api/ocr-qrcode" \
  -H "Authorization: Bearer $APIZERO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input_type": "url",
  "input_data": "https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=https%3A%2F%2Fwww.apizero.cn"
}'
```

### Python

```python
# 服务端常规写法：标准库 urllib，不用 pip
# 设置环境变量 APIZERO_KEY 后运行，不要把 Key 写进前端
# 密钥：https://apizero.cn/account/keys
import json
import os
import ssl
import urllib.error
import urllib.request

key = os.environ.get("APIZERO_KEY") or ""
if not key:
    raise SystemExit("请在服务端设置环境变量 APIZERO_KEY，不要把 Key 写进前端")

url = "https://v1.apizero.cn/api/ocr-qrcode"
payload = {
    "input_type": "url",
    "input_data": "https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=https%3A%2F%2Fwww.apizero.cn",
}
req = urllib.request.Request(
    url,
    data=json.dumps(payload, ensure_ascii=False).encode("utf-8"),
    headers={
        "Authorization": "Bearer " + key,
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urllib.request.urlopen(
        req, timeout=20, context=ssl.create_default_context()
    ) as resp:
        raw = resp.read().decode("utf-8")
except urllib.error.HTTPError as e:
    raw = e.read().decode("utf-8", "replace")
body = json.loads(raw)
print(json.dumps(body, ensure_ascii=False, indent=2))
if body.get("code") == 0:
    print(body.get("data"))
```

### Python 官方库

```python
# 官方库（服务端）：先执行一次 pip install apizero
# 设置环境变量 APIZERO_KEY 后运行，不要把 Key 写进前端
# https://apizero.cn/account/keys
import os
import apizero

key = os.environ.get("APIZERO_KEY") or ""
if not key:
    raise SystemExit("请在服务端设置环境变量 APIZERO_KEY，不要把 Key 写进前端")
client = apizero.key(key)
r = client.ocr_qrcode(
    input_type="url",
    input_data="https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=https%3A%2F%2Fwww.apizero.cn",
)
if not r.ok:
    raise RuntimeError(r.msg)
print(r.ok, r.code)
print(r.json)
```

### JavaScript

```javascript
// 服务端 Node 18+ fetch，不要把 Key 写进浏览器 / 小程序 / 前端打包
// 设置环境变量 APIZERO_KEY 后运行
// 密钥：https://apizero.cn/account/keys
const key = process.env.APIZERO_KEY;
if (!key) throw new Error("请在服务端设置环境变量 APIZERO_KEY，不要把 Key 写进前端");
const url = "https://v1.apizero.cn/api/ocr-qrcode";
const res = await fetch(url, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${key}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "input_type": "url",
  "input_data": "https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=https%3A%2F%2Fwww.apizero.cn",
}),
});
const body = await res.json();
console.log(body);
if (body.code === 0) console.log(body.data);
```

### JavaScript 官方库（Node）

```javascript
// 官方库（服务端 Node）：先执行一次 npm install @apex-origin/apizero
// 设置环境变量 APIZERO_KEY 后运行
// 不要把 Key 写进浏览器 / Vue / React / 小程序
// https://apizero.cn/account/keys
const { key } = require("@apex-origin/apizero");
// ESM: import { key } from "@apex-origin/apizero";

const apiKey = process.env.APIZERO_KEY;
if (!apiKey) throw new Error("请在服务端设置环境变量 APIZERO_KEY，不要把 Key 写进前端");
const client = key(apiKey);
const r = await client.ocr_qrcode({
  "input_type": "url",
  "input_data": "https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=https%3A%2F%2Fwww.apizero.cn",
});
if (!r.ok) throw new Error(r.msg);
console.log(r.ok, r.code);
console.log(r.json);
```

### Go

```go
// 服务端常规写法：net/http
// 设置环境变量 APIZERO_KEY 后运行，不要把 Key 写进前端
// 密钥：https://apizero.cn/account/keys
package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	key := os.Getenv("APIZERO_KEY")
	if key == "" {
		panic("请在服务端设置环境变量 APIZERO_KEY，不要把 Key 写进前端")
	}

	url := "https://v1.apizero.cn/api/ocr-qrcode"
	payload, err := json.Marshal(map[string]any{
		"input_type": "url",
		"input_data": "https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=https%3A%2F%2Fwww.apizero.cn",
	})
	if err != nil {
		panic(err)
	}
	req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+key)
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	raw, _ := io.ReadAll(resp.Body)
	fmt.Println(string(raw))
}
```

### Java

```java
// 服务端常规写法：Java 11+ HttpClient
// Jackson：com.fasterxml.jackson.databind.ObjectMapper
// 设置环境变量 APIZERO_KEY 后运行，不要把 Key 写进前端
// 密钥：https://apizero.cn/account/keys
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.net.URI;
import java.util.LinkedHashMap;
import java.util.Map;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;

public class Example {
    public static void main(String[] args) throws Exception {
        String key = System.getenv("APIZERO_KEY");
        if (key == null || key.isBlank()) {
            throw new IllegalStateException("请在服务端设置环境变量 APIZERO_KEY，不要把 Key 写进前端");
        }
        ObjectMapper mapper = new ObjectMapper();
        String url = "https://v1.apizero.cn/api/ocr-qrcode";

        Map<String, Object> payload = new LinkedHashMap<>();
        payload.put("input_type", "url");
        payload.put("input_data", "https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=https%3A%2F%2Fwww.apizero.cn");
        String json = mapper.writeValueAsString(payload);

        HttpClient client = HttpClient.newBuilder()
                .connectTimeout(Duration.ofSeconds(10))
                .build();
        HttpRequest req = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("Authorization", "Bearer " + key)
                .timeout(Duration.ofSeconds(20))
                .header("Content-Type", "application/json")
                .POST(HttpRequest.BodyPublishers.ofString(json))
                .build();
        HttpResponse<String> resp = client.send(req, HttpResponse.BodyHandlers.ofString());
        JsonNode body = mapper.readTree(resp.body());
        System.out.println(resp.body());
        if (body.path("code").asInt() == 0) {
            System.out.println(body.path("data"));
        }
    }
}
```

### PHP

```php
<?php
// 服务端常规写法：curl，强制 TLS 1.2
// 设置环境变量 APIZERO_KEY 后运行，不要把 Key 写进前端
// 密钥：https://apizero.cn/account/keys
$key = getenv('APIZERO_KEY') ?: '';
if ($key === '') {
    fwrite(STDERR, "请在服务端设置环境变量 APIZERO_KEY，不要把 Key 写进前端" . PHP_EOL);
    exit(1);
}

$ch = curl_init("https://v1.apizero.cn/api/ocr-qrcode");
$opts = [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 20,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer '.$key,
        'Content-Type: application/json',
    ],
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode([
    "input_type" => "url",
    "input_data" => "https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=https%3A%2F%2Fwww.apizero.cn",
], JSON_UNESCAPED_UNICODE),
];
if (defined('CURL_SSLVERSION_TLSv1_2')) {
    $opts[CURLOPT_SSLVERSION] = CURL_SSLVERSION_TLSv1_2;
}
curl_setopt_array($ch, $opts);
$raw = curl_exec($ch);
if ($raw === false) {
    fwrite(STDERR, 'cURL Error: '.curl_error($ch).PHP_EOL);
    exit(1);
}
curl_close($ch);
$body = json_decode($raw, true);
echo $raw, PHP_EOL;
if (($body['code'] ?? null) === 0) {
    echo json_encode($body['data'] ?? null, JSON_UNESCAPED_UNICODE), PHP_EOL;
}
```

### Rust

```rust
// 服务端常规写法
// cargo add reqwest --features json,blocking ; cargo add serde_json
// 设置环境变量 APIZERO_KEY 后运行，不要把 Key 写进前端
// 密钥：https://apizero.cn/account/keys
use reqwest::blocking::Client;
use reqwest::header::{HeaderMap, HeaderValue, AUTHORIZATION};
use serde_json::Value;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let key = std::env::var("APIZERO_KEY").expect("请在服务端设置环境变量 APIZERO_KEY，不要把 Key 写进前端");

    let url = "https://v1.apizero.cn/api/ocr-qrcode";
    let mut headers = HeaderMap::new();
    headers.insert(
        AUTHORIZATION,
        HeaderValue::from_str(&format!("Bearer {key}"))?,
    );
    headers.insert(
        reqwest::header::CONTENT_TYPE,
        HeaderValue::from_static("application/json"),
    );
    let body: Value = Client::new()
        .post(url)
        .json(&serde_json::json!({
        "input_type": "url",
        "input_data": "https://api.qrserver.com/v1/create-qr-code/?size=200x200&data=https%3A%2F%2Fwww.apizero.cn",
    }))
        .headers(headers)
        .timeout(std::time::Duration::from_secs(20))
        .send()?
        .json()?;
    println!("{}", serde_json::to_string_pretty(&body)?);
    Ok(())
}
```

## 8. 错误码

先看业务 code。HTTP 也可能不是 200。

| 业务码 | HTTP | 说明 |
| --- | --- | --- |
| 0 | 200 | 成功 |
| 4000 | 400 | 参数错误 |
| 4011 | 401 | API Key 无效 |
| 4013 | 403 | API Key 已暂停 |
| 4014 | 403 | 当前 IP 不在 Key 白名单 |
| 4015 | 401 | 此接口需要 API Key |
| 4022 | 402 | 余额不足 |
| 4029 | 429 | 调用过快（QPS） |
| 4030 | 429 | 今日免费额度已用完 |
| 4040 | 503 | 接口已下线 |
| 4041 | 404 | 接口不存在 |
| 5000 | 500 | 服务器内部错误 |
| 5020 | 502 | 上游暂时不可用 |
| 5021 | 502 | 上游返回格式异常 |
| 5030 | 502 | 暂无可用节点 |


## 9. 变更日志

- **1.0.0** (2026-09-08): 上架二维码 / 条形码识别，支持一图多码
登录每天 10 次；黄金每天 100 次；企业走共享额度