API接口文档
详细的API接口说明与示例
接口概述
本API文档为二维码平台提供RESTful API接口规范,支持用户通过API Key进行身份验证,并获取二维码相关信息、统计数据等功能。
身份验证
所有API请求都需要在请求头中包含有效的API Key (可以在后台获取个人的APIKEY):
基础信息
- Base URL:
/api/v1
- Content-Type:
application/json
- 认证方式: API Key Header
接口列表
1. 获取单个二维码详情
根据二维码ID获取详细信息。
HTTP请求
响应示例
无权限响应
2. 获取二维码统计数据
获取指定二维码的详细统计数据。
HTTP请求
响应示例
错误码说明
状态码 | 描述 |
---|---|
200 | 请求成功 |
401 | 未授权,API Key无效或缺失 |
404 | 资源未找到或访问被拒绝 |
429 | 超过API调用限制 |
500 | 服务器内部错误 |
使用示例
JavaScript (Axios)
cURL 命令示例
注意事项
- API Key安全: 请勿将API Key暴露在客户端代码中
- 频率限制: 每个用户每天最多调用100次API
- 分页: 列表接口默认每页20条记录,最大支持100条
- 时区: 所有时间均为UTC格式
- 错误处理: 建议对所有API调用进行错误处理
后续扩展
- 支持创建二维码API
- 支持更新二维码API
- 支持删除二维码API
- 支持批量操作API
- 支持Webhook通知
- 支持自定义配额设置