microblink/api

Microblink API 镜像文档

镜像概述和主要用途

Microblink API 镜像是一个本地部署的自托管 OCR 应用服务器，提供身份证件识别功能。该镜像支持扫描超过 500 种国际身份证件，包括驾照、国民身份证、护照等官方文档，适用于需要在自有基础设施上部署高性能证件识别服务的场景。

核心功能和特性

• 多证件识别：支持全球 500+ 种身份证件类型的 OCR 扫描与数据提取
• 自托管部署：可在企业内部服务器或私有环境中部署，确保数据本地化处理
• 灵活扩展：通过环境变量配置工作节点数量、超时时间等参数，适配不同负载需求
• 安全可控：支持基础认证、CORS 配置、证书信任管理等安全特性
• 多版本支持：提供 4.x 系列（最新稳定版）和 1.x 系列（旧版兼容）镜像标签

支持的标签

4.x 系列（推荐）

• 4.2, 4.2.1, latest（最新稳定版）
• 4.1, 4.1.0

1.x 系列（旧版兼容）

• 1.42.1（回溯版本）
• 1.40（回溯版本）
• 1, 1.36, 1.36.1

使用场景和适用范围

• 企业内部证件核验系统：***、保险等行业需本地化处理客户身份证件信息的场景
• 边境管理与安防：海关、机场等需要快速识别国际旅行证件的场所
• 远程身份验证：在线服务平台通过本地部署实现用户证件的安全核验
• 数据隐私合规：对数据出境有严格要求的组织，需在私有环境处理敏感证件数据

使用方法和配置说明

前置要求：许可证信息

运行此 Docker 镜像必须提供 Licensee 和 License Key！

1. 访问 Microblink Developer Hub 创建账户
2. 联系销售团队（***）获取 DEMO 或 PRODUCTION 级别的许可证组合（包含 licensee 和 license key）
3. 许可证信息将用于配置部署参数

部署方式一：Docker Compose（推荐）

1. 下载官方 Docker Compose 模板：
   [***]

2. 编辑 docker-compose.yml 文件，替换 LICENSEE 和 LICENSE_KEY 为实际许可证信息

3. 启动服务：

   bash
   docker-compose up -d
   

4. 服务将在 http://localhost:8080 可用

部署方式二：Docker Run 命令

直接通过 docker run 启动服务：

bash
docker run -p 8080:8080 \
  -e "LICENSEE=你的许可证持有者名称" \
  -e "LICENSE_KEY=你的许可证密钥" \
  -v /etc/machine-id:/etc/machine-id \
  -v /var/lib/dbus/machine-id:/var/lib/dbus/machine-id \
  microblink/api

服务启动后可通过 http://localhost:8080 访问 API 端点

环境变量配置

核心配置（必填项）

服务配置（常用项）

高级配置（不建议默认修改）

完整环境变量说明参见 官方文档

文档和资源

官方文档

• 自托管 API 完整文档
• Zendesk 知识库
• 开发者官网

示例和工具

• Postman 接口示例集合
• https://github.com/BlinkID/blinkid-imagecapture-in-browser

开源依赖清单

• 应用使用的开源软件依赖列表

支持信息

如在集成或使用中遇到问题，请联系技术支持：
📧 ：

旧版本（1.x）文档

支持的标签

• 1.42.1（回溯版本）
• 1.40（回溯版本）
• 1, 1.36, 1.36.1

使用方法

推荐通过 Docker Compose 部署，模板参见 https://github.com/microblink/docker/blob/master/api/docker-compose.yml%E3%80%82

环境变量

1.x 版本环境变量分类说明：

• REQUIRED：必须配置，否则服务无法启动（如 LICENSEE、LICENSE_KEY）
• OPTIONAL：控制特定功能行为（如 PORT、WORKERS_POOL_SIZE）
• ADVANCED：高级调优参数，默认值已适配通用场景

详细说明参见 https://github.com/microblink/docker/blob/master/api/Dockerfile%E3%80%82

发布说明

• 1.x 版本更新日志