Discuz API接口插件是一款专注于用户系统对接的插件,提供标准的用户注册和登录API接口。通过这款插件,您可以轻松实现论坛用户系统与其他应用的无缝对接。
【API接口详细说明】
1. 用户注册接口
接口地址:http://你的域名/plugin.php?id=codeium_api:api&action=register
请求方式:GET
请求参数:
- username: 用户名(必填,4-15个字符)
- password: 密码(必填,6位以上)
- email: 邮箱(必填,有效的邮箱格式)
- key: API密钥(必填,后台设置)
返回格式:JSON
成功返回示例:
{
"code": 0,
"message": "Register successful",
"data": {
"uid": "10",
"username": "test123",
"email": "test@example.com"
}
}
错误返回示例:
{
"code": -5,
"message": "Username already exists",
"data": null
}
错误码说明:
-1: API服务已禁用
-2: 无效的API密钥
-3: 缺少必要参数
-5: 注册失败(具体原因见message)
2. 用户登录接口
接口地址:http://你的域名/plugin.php?id=codeium_api:api&action=login
请求方式:GET
请求参数:
- username: 用户名(必填)
- password: 密码(必填)
- key: API密钥(必填,后台设置)
返回格式:JSON
成功返回示例:
{
"code": 0,
"message": "Login successful",
"data": {
"uid": "10",
"username": "test123",
"email": "test@example.com"
}
}
错误返回示例:
{
"code": -4,
"message": "Login failed",
"data": null
}
错误码说明:
-1: API服务已禁用
-2: 无效的API密钥
-3: 缺少必要参数
-4: 登录失败
【接口特点】
1. 注册接口特点
- 自动同步用户数据到UC和Discuz数据库
- 支持用户名和邮箱合法性检查
- 可在后台配置新用户默认用户组
- 自动创建用户相关数据表记录
2. 登录接口特点
- 自动维护用户登录状态
- 支持长期登录状态保持
- 返回完整的用户基础信息
- 支持多终端同时登录
【安全性说明】
1. API密钥验证
- 所有接口调用都需要提供有效的API密钥
- 密钥可在后台随时更换
- 建议使用HTTPS传输确保安全
2. 数据验证
- 用户名合法性验证
- 邮箱格式验证
- 密码强度检查
- 防SQL注入处理
【使用建议】
1. 开发建议
- 建议使用HTTPS协议调用接口
- 在服务端进行接口调用,避免密钥泄露
- 做好接口调用的错误处理
- 保存好返回的用户信息
2. 配置建议
- 定期更换API密钥
- 根据需求设置合适的用户组
- 定期检查API调用日志
- 做好异常情况的处理预案
【技术支持】
- 安装配置指导
- 接口调用问题解答
- 故障排查支持
- 功能定制咨询
-
当前版本
1.1
-
2025-01-02 14:28
1.1
增加api接口:
用户信息
积分操作
发送系统提醒
发表回复
验证账号
获取用户列表
获取帖子列表
获取回帖列表
获取版块列表
-
2024-12-20 01:50
1.0
更多历史版本信息
增加api接口:
用户信息
积分操作
发送系统提醒
发表回复
验证账号
获取用户列表
获取帖子列表
获取回帖列表
获取版块列表