API 接口文档

概述

本平台提供 RESTful API 接口，用于集成实名认证功能。所有接口均使用 HTTPS 协议，数据传输采用 JSON 格式。

接口基础地址：https://sm.avuoo.com

认证方式

调用 API 接口时，需要在请求头中携带 API Key 进行身份验证：

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

API Key 可在管理后台的"密钥管理"中获取。

1. 发起认证

用于发起实名认证请求。

请求地址

POST /api/auth.php

请求参数

参数名	类型	必填	说明
name	string	是	用户真实姓名
cert_no	string	是	身份证号码
interface_id	int	是	认证接口ID
callback_url	string	否	回调地址
key_id	int	是	使用的密钥ID

请求示例

curl -X POST https://sm.avuoo.com/api/auth.php \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "张三",
    "cert_no": "110101199001011234",
    "interface_id": 1,
    "callback_url": "https://your-domain.com/callback",
    "key_id": 1
  }'

响应示例

{
  "code": 0,
  "message": "success",
  "data": {
    "auth_id": "AUTH202501010001",
    "auth_url": "https://auth.aliyun.com/...",
    "expire_time": 300
  }
}

2. 查询认证结果

用于查询指定认证请求的结果。

请求地址

GET /api/auth.php?action=query&auth_id=AUTH202501010001

请求参数

参数名	类型	必填	说明
action	string	是	固定值：query
auth_id	string	是	认证流水号

响应示例

{
  "code": 0,
  "message": "success",
  "data": {
    "auth_id": "AUTH202501010001",
    "status": "success",
    "name": "张三",
    "cert_no": "110101********1234",
    "verified_at": "2025-01-01 12:00:00"
  }
}

3. 回调通知

认证完成后，系统会向您指定的回调地址发送 POST 请求，通知认证结果。

回调参数

参数名	类型	说明
auth_id	string	认证流水号
status	string	认证状态（success/fail）
name	string	用户姓名
cert_no	string	身份证号（脱敏）
message	string	认证结果描述
sign	string	签名（用于验证回调真实性）

回调示例

{
  "auth_id": "AUTH202501010001",
  "status": "success",
  "name": "张三",
  "cert_no": "110101********1234",
  "message": "认证通过",
  "sign": "abc123def456..."
}

错误码说明

错误码	说明
0	请求成功
1001	参数错误
1002	认证失败
1003	接口不可用
2001	API Key 无效
2002	密钥不存在或已禁用
3001	系统内部错误
3002	请求频率过高