API文档

智能车牌识别API开发者指南

开始使用

注册账户后即可获得免费API额度,立即开始您的智能车牌识别之旅!

🚀 快速开始
1. 获取API密钥

注册账户后,在API密钥管理页面创建密钥:

  • 快速创建:点击绿色按钮创建永不过期的简单密钥
  • 高级创建:自定义名称、权限和过期时间
2. 四种认证方式
方式1 - Header认证(推荐):
Authorization: Bearer lpr_username_xxxxxxxx

方式2 - URL参数:
?api_key=lpr_username_xxxxxxxx

方式3 - POST表单:
api_key=lpr_username_xxxxxxxx

方式4 - JSON数据:
{"api_key": "lpr_username_xxxxxxxx"}
3. 基础信息
  • API基础URL: http://yolo.rxleaf.cn/api/
  • 请求格式: multipart/form-data(文件上传)
  • 响应格式: JSON
  • 字符编码: UTF-8
4. 速率限制
  • 免费用户:每日1000次
  • 付费用户:根据套餐而定
  • 超出限制返回429错误
📋 API端点
POST /api/recognize
车牌识别

上传图片进行车牌识别,支持多种车牌类型和颜色。

请求参数
参数名 类型 必填 说明
image File 要识别的图片文件(支持jpg、png、gif、bmp格式)
api_key String 否* API密钥(如果不使用Header认证)
响应示例
{ "success": true, "message": "识别成功", "data": { "plate_text": "京A12345", "confidence": 0.98, "color": "蓝色", "province": "北京", "bbox": [100, 150, 200, 180], "processing_time": 0.85 }, "task_id": 12345, "record_id": 67890, "quota_info": { "daily_remaining": 995, "monthly_remaining": 29995 } }
GET /api/records/{task_id}
获取任务记录

根据任务ID获取识别记录详情。

URL参数
参数名 类型 必填 说明
task_id Integer 任务ID
GET /api/stats
用户统计信息

获取当前用户的使用统计信息。

响应示例
{ "success": true, "data": { "total_tasks": 150, "success_tasks": 147, "today_tasks": 5, "month_tasks": 89, "success_rate": 98.0, "quota_info": { "daily_used": 5, "daily_total": 1000, "monthly_used": 89, "monthly_total": 30000 } } }
GET /api/system-stats
系统状态

获取系统运行状态信息(需要管理员权限)。

⚠️ 错误码说明
状态码 说明 解决方案
200 请求成功 -
400 请求参数错误 检查必填参数是否完整,文件格式是否正确
401 身份验证失败 检查API密钥是否正确,支持Header、URL参数、POST表单、JSON四种认证方式
403 权限不足 检查API密钥是否有相应权限
429 超出速率限制 等待限制重置或升级套餐
500 服务器内部错误 联系技术支持
💻 Python代码示例

完整的Python测试脚本,包含所有API端点的调用示例:

import requests import json import time from pathlib import Path class LPRAPIClient: """智能车牌识别API客户端""" def __init__(self, api_key, base_url="https://yolo.rxdev.cloud"): self.api_key = api_key self.base_url = base_url.rstrip('/') self.session = requests.Session() # 设置默认请求头 self.session.headers.update({ 'Authorization': f'Bearer {api_key}', 'User-Agent': 'LPR-API-Client/1.0' }) def recognize_image(self, image_path, use_header_auth=True): """ 车牌识别API调用 Args: image_path (str): 图片文件路径 use_header_auth (bool): 是否使用Header认证 Returns: dict: API响应结果 """ url = f"{self.base_url}/api/recognize" try: # 准备文件 with open(image_path, 'rb') as f: files = {'image': f} # 准备数据 data = {} if not use_header_auth: data['api_key'] = self.api_key print(f"🚀 开始识别图片: {Path(image_path).name}") start_time = time.time() # 发送请求 response = self.session.post(url, files=files, data=data) request_time = round((time.time() - start_time) * 1000, 2) print(f"⏱️ 请求耗时: {request_time}ms") print(f"📡 响应状态: {response.status_code}") if response.status_code == 200: result = response.json() if result.get('success'): data = result.get('data', {}) print(f"✅ 识别成功!") print(f"🔢 车牌号码: {data.get('plate_text', 'N/A')}") print(f"🎨 车牌颜色: {data.get('color', 'N/A')}") print(f"🎯 识别置信度: {data.get('confidence', 0):.2%}") print(f"📍 省份信息: {data.get('province', 'N/A')}") print(f"📦 边界框: {data.get('bbox', 'N/A')}") print(f"⚡ 处理时间: {data.get('processing_time', 0):.2f}s") # 额度信息 quota_info = result.get('quota_info', {}) print(f"📊 今日剩余: {quota_info.get('daily_remaining', 'N/A')}") print(f"📈 本月剩余: {quota_info.get('monthly_remaining', 'N/A')}") # 任务信息 print(f"🆔 任务ID: {result.get('task_id', 'N/A')}") print(f"🆔 记录ID: {result.get('record_id', 'N/A')}") else: print(f"❌ 识别失败: {result.get('message', '未知错误')}") return result else: print(f"❌ 请求失败: {response.status_code}") try: error_info = response.json() print(f"错误信息: {error_info}") except: print(f"错误信息: {response.text}") return None except FileNotFoundError: print(f"❌ 文件不存在: {image_path}") return None except Exception as e: print(f"❌ 请求异常: {str(e)}") return None def get_user_stats(self): """获取用户统计信息""" url = f"{self.base_url}/api/stats" try: print("📊 获取用户统计信息...") response = self.session.get(url) if response.status_code == 200: result = response.json() if result.get('success'): data = result.get('data', {}) print("✅ 统计信息获取成功!") print(f"📋 总任务数: {data.get('total_tasks', 0)}") print(f"✅ 成功任务: {data.get('success_tasks', 0)}") print(f"📅 今日任务: {data.get('today_tasks', 0)}") print(f"📆 本月任务: {data.get('month_tasks', 0)}") print(f"🎯 成功率: {data.get('success_rate', 0):.1f}%") quota_info = data.get('quota_info', {}) print(f"📊 今日使用: {quota_info.get('daily_used', 0)}/{quota_info.get('daily_total', 0)}") print(f"📈 本月使用: {quota_info.get('monthly_used', 0)}/{quota_info.get('monthly_total', 0)}") return result else: print(f"❌ 获取统计信息失败: {response.status_code}") return None except Exception as e: print(f"❌ 请求异常: {str(e)}") return None def get_task_record(self, task_id): """获取任务记录""" url = f"{self.base_url}/api/records/{task_id}" try: print(f"📋 获取任务记录: {task_id}") response = self.session.get(url) if response.status_code == 200: result = response.json() print("✅ 任务记录获取成功!") return result else: print(f"❌ 获取任务记录失败: {response.status_code}") return None except Exception as e: print(f"❌ 请求异常: {str(e)}") return None def main(): """主函数 - 完整的API测试流程""" # ⚠️ 请替换为您的实际API密钥 API_KEY = "lpr_username_xxxxxxxxxxxxxxxx" BASE_URL = "https://yolo.rxdev.cloud" # 或您的API地址 print("🎯 智能车牌识别API测试工具") print("=" * 50) # 初始化客户端 client = LPRAPIClient(API_KEY, BASE_URL) # 1. 测试车牌识别(Header认证) print("\n🧪 测试1: 车牌识别 (Header认证)") print("-" * 30) image_path = "test_image.jpg" # 请替换为实际图片路径 result = client.recognize_image(image_path, use_header_auth=True) task_id = result.get('task_id') if result else None # 2. 测试车牌识别(URL参数认证) print("\n🧪 测试2: 车牌识别 (URL参数认证)") print("-" * 30) client.recognize_image(image_path, use_header_auth=False) # 3. 测试获取用户统计 print("\n🧪 测试3: 用户统计信息") print("-" * 30) client.get_user_stats() # 4. 测试获取任务记录 if task_id: print("\n🧪 测试4: 获取任务记录") print("-" * 30) client.get_task_record(task_id) print("\n✨ 测试完成!") print("如需更多帮助,请查看API文档或联系技术支持。") if __name__ == "__main__": main()
📊 API额度说明
免费套餐
  • 每日1000次识别额度
  • 支持所有车牌类型识别
  • 基础技术支持
付费套餐
  • 更高的日/月额度
  • 优先处理通道
  • 专属技术支持
❓ 常见问题

注册账户后,登录系统,在"API密钥"页面可以创建和管理您的密钥。建议使用"快速创建"功能生成永不过期的简单密钥。

支持JPG、PNG、GIF、BMP等常见图片格式,建议图片大小不超过10MB,分辨率不低于200x200像素以获得最佳识别效果。

基于最新的YOLOv8+CRNN深度学习架构,在标准场景下识别准确率超过98%。对于模糊、倾斜、部分遮挡等复杂场景也有很好的识别效果。
🛠️ 技术支持
联系方式
  • 📧 邮箱:support@example.com
  • 📱 电话:400-xxx-xxxx
  • 💬 在线客服:工作日 9:00-18:00
开发资源