Skip to main content

接口认证

1. 接口概述​

基础 URL：

  • HTTP： http://user.ipweb.cc/prod-api
  • HTTPS： https://user.ipweb.cc/prod-api

支持格式： JSON

字符编码： UTF-8

协议支持： 同时支持 HTTP 和 HTTPS 协议，推荐使用 HTTPS 以确保数据传输安全

2. 认证方式​

认证方式： Token 认证

所有 API 请求都需要在请求头中包含有效的认证令牌。系统会验证令牌的有效性，无效令牌将返回认证失败错误。

请求头格式​

在所有 API 请求中，需要在 HTTP 请求头中添加以下认证信息：

Token: your_access_token_here

示例​

# 使用curl命令示例
curl -X GET "http://user.ipweb.cc/prod-api/open/customer/list?pageNum=1&pageSize=10&userName=" -H "token: your-access-token"

Token 格式说明​

  • 请求头名称： Token
  • Token 值： 由系统分配的访问令牌字符串
  • Token 长度： 通常为 32-64 位字符的字母数字组合
  • 有效期： Token 具有有效期限制，过期后需要重新获取
  • 安全性： 请妥善保管 Token，避免泄露给第三方

3. 响应格式说明​

所有 API 接口都返回统一的 JSON 格式响应：

字段名类型说明
codeInteger响应状态码，200 表示成功
msgString响应消息
dataObject响应数据，具体结构根据接口而定

4. 错误码说明​

以下是动态流量相关 API 接口可能返回的错误码及其说明：

错误码说明解决方案
200无效的认证令牌检查 Token 是否正确且未过期
200账号信息不完整联系管理员检查账户信息
500服务器内部错误联系技术支持

错误响应示例：

{
  "code": 200,
  "msg": "无效的认证令牌",
  "data": null
}