API 开发者文档

小阿军智联平台 统一账号开放接口 · 版本 2.0

一、概述

开放 API 用于让您的网站、小程序、桌面程序与 小阿军智联平台 共用一套用户账号:在本平台登录后,可携带 access_token 在您的应用中识别用户身份,并查询是否已购买指定产品。

接口基址(请替换为您的正式域名):

http://zgsgsbfx/api

在线接口索引(JSON):http://zgsgsbfx/api(浏览器访问可查看端点列表)

二、接入准备

  1. 注册并登录本平台账号。
  2. 进入 开发者平台,创建 OAuth 应用,获取 app_idapp_secret
  3. 在应用设置中配置回调地址、数据权限范围(scope)及是否允许注册。
  4. 在您的服务端保存 app_secret切勿写入前端代码或公开仓库

三、鉴权说明

3.1 应用级鉴权

除公开说明的接口外,所有请求须携带:

  • app_id:应用 ID
  • app_secret:应用密钥(仅服务端调用)

支持 application/x-www-form-urlencodedmultipart/form-data 的 POST 参数,部分接口亦支持 GET 传参(不推荐)。

3.2 用户级鉴权

登录接口返回 access_token,调用用户信息、产品权限等接口时需同时传入 access_token。Token 过期请使用刷新接口获取新 Token。

四、接口列表

方法 路径 说明
POST/api/login用户登录,返回 access_token
POST/api/verify-token校验 token 是否有效
POST/api/user-info获取用户信息(按应用权限返回字段)
POST/api/check-product-access检查用户是否已开通指定/关联产品
POST/api/refresh-token刷新 access_token
POST/api/register代注册(需应用开启 allow_register)
POST/api/check-account检查账号是否已存在

五、请求与响应

5.1 登录示例

POST http://zgsgsbfx/api/login
Content-Type: application/x-www-form-urlencoded

app_id=您的应用ID
app_secret=您的应用密钥
username=用户邮箱或用户名
password=用户密码

5.2 成功响应格式

{
  "code": 0,
  "msg": "ok",
  "data": {
    "access_token": "...",
    "expires_in": 7200,
    "user_id": 123
  }
}

5.3 失败响应格式

{
  "code": 403,
  "msg": "app_secret 验证失败",
  "data": null
}

六、错误码说明

  • code = 0:成功,业务数据在 data 字段。
  • code ≠ 0 或 HTTP 4xx/5xx:失败,msg 为可读错误说明。
  • 常见原因:缺少参数、密钥错误、Token 过期、用户无产品权限、应用未开启注册等。

七、安全建议

  • app_secret 仅保存在您服务器环境变量或配置中,禁止暴露给浏览器。
  • 生产环境务必使用 HTTPS(http://zgsgsbfx)。
  • 按最小权限配置应用 scope,只申请业务需要的用户字段。
  • Token 请加密存储,并定期刷新;发现泄露立即在开发者平台重置密钥。

接口与商务咨询邮箱:admin@arjunlink.com

进入开发者平台 → 使用帮助文档