开发文档 - API管理平台

概述

API管理平台提供丰富的接口服务，支持身份验证、企业信息查询、数据统计等功能。所有接口均采用RESTful设计风格，返回JSON格式数据。

基础信息

接口域名：https://api.example.com
API版本：v1
请求方式：GET/POST/PUT/DELETE
数据格式：JSON
字符编码：UTF-8

请求头

Content-Type: application/json
Authorization: Bearer {token}
                

认证授权

所有API接口都需要通过Token认证，获取Token后在请求头中携带Token信息。

获取Token

通过账号密码获取访问Token，Token有效期为2小时。

参数	说明	类型	是否必填
username	用户名/手机号/邮箱	string	是
password	密码	string	是

// 请求示例
POST /v1/auth/token
Content-Type: application/json

{
  "username": "13800138000",
  "password": "your_password"
}

// 响应示例
{
  "code": 200,
  "message": "success",
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expires_in": 7200
  }
}
                

刷新Token

使用refresh_token刷新获取新的access_token。

// 请求示例
POST /v1/auth/refresh
Content-Type: application/json

{
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

// 响应示例
{
  "code": 200,
  "message": "success",
  "data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expires_in": 7200
  }
}
                

API接口

用户身份验证接口

验证用户身份信息的真实性和有效性。

// 请求示例
POST /v1/user/verify
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

{
  "name": "张三",
  "id_card": "110101199001011234",
  "mobile": "13800138000"
}

// 响应示例
{
  "code": 200,
  "message": "success",
  "data": {
    "verified": true,
    "user_info": {
      "name": "张三",
      "id_card": "11010119900101****",
      "mobile": "138****8000"
    }
  }
}
                

企业信息查询接口

查询企业工商注册信息。

// 请求示例
GET /v1/company/info?company_name=百度&credit_code=91110000802100433B
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

// 响应示例
{
  "code": 200,
  "message": "success",
  "data": {
    "company_name": "百度在线网络技术（北京）有限公司",
    "credit_code": "91110000802100433B",
    "establish_date": "1999-09-09",
    "legal_person": "梁志祥",
    "registered_capital": "1342128万人民币",
    "status": "存续"
  }
}
                

错误码

错误码	说明	解决方案
200	请求成功	-
400	参数错误	检查请求参数是否正确
401	未授权/Token过期	重新获取Token
403	权限不足	联系管理员提升权限
404	接口不存在	检查接口地址是否正确
500	服务器内部错误	联系技术支持

常见问题

Q1: Token过期了怎么办？
A1: 可以使用refresh_token调用刷新Token接口获取新的access_token，或者重新登录。

Q2: 接口调用频率限制是多少？
A2: 默认每个用户每分钟最多调用60次，如需更高频率请联系客服申请。

Q3: 如何保证接口调用的安全性？
A3: 建议使用HTTPS协议，Token不要明文传输，定期更换密码，避免Token泄露。

API开发文档

概述