基础功能
检测 API 请求标头
php
\FresnsCmdWord::plugin('Fresns')->checkHeaders();- 参数值见 API 请求标头
结果示例
json
{
"code": 0,
"message": "ok",
"data": {
"appId": "qe12345",
"platformId": 4,
"version": "2.0.0",
"deviceInfo": "",
"langTag": "zh-Hans",
"timezone": "+8",
"contentFormat": "",
"aid": "6a3bb3bc",
"aidToken": "uoX1hk6SHUgB2MFGJwNx38dem9DA7Vsz",
"uid": 782622,
"uidToken": "PqBpwPLJgfd1sH0X5JffYFGxTSc8RW7c",
"signature": "d5db4371a0c2d7e17009dea8d53ecf15a7ec07b9",
"timestamp": 1626426833
}
}校验签名
php
\FresnsCmdWord::plugin('Fresns')->verifySign($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| appId | String | YES | App ID |
| platformId | Number | YES | 平台编号（配置表 platforms 键名的键值） |
| version | String | YES | 语义化版本号 |
| timestamp | Number | YES | 签名生成时间（当前 Unix 时间戳，精确到秒或毫秒都支持） |
| signature | String | YES | 请求签名 |
| aid | String | NO/YES | 账号参数（账号主表 accounts->aid 字段） |
| aidToken | String | NO/YES | 账号身份凭证 |
| uid | Number | NO/YES | 用户参数（用户主表 users->uid 字段） |
| uidToken | String | NO/YES | 用户身份凭证 |
| verifyType | Number | NO | 验证 session_keys->type，留空则默认为 1 |
| verifyFskey | String | NO | 类型为 3 时专用，验证关联插件 |
验证访问令牌
php
\FresnsCmdWord::plugin('Fresns')->verifyAccessToken($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| accessToken | String | YES | 参见：为插件生成访问令牌 |
| accountLogin | Boolean | NO | 是否要求必须登录账号，留空则不要求 |
| userLogin | Boolean | NO | 是否要求必须登录用户，留空则不要求 |
逻辑说明
用户将通过 URL 访问插件页面，URL 中会传参凭证信息，用于一键登录。
- 1、先使用 URL Encode 解码
{accessToken}变量名的值，得到 base64 加密字符串 - 2、再使用 base64 解密字符串，得到 json object 格式的
headers数据 - 3、获取 headers 中生成签名的信息，校验签名是否正确，正确则
code为0 - 4、无论是否正确，都输出 headers 信息，格式见下方结果示例。
结果示例
json
{
"code": 0,
"message": "ok",
"data": {
"appId": "qe12345",
"platformId": 4,
"version": "2.0.0",
"deviceInfo": "",
"langTag": "zh-Hans",
"timezone": "+8",
"contentFormat": "",
"aid": "6a3bb3bc",
"aidToken": "uoX1hk6SHUgB2MFGJwNx38dem9DA7Vsz",
"uid": 782622,
"uidToken": "PqBpwPLJgfd1sH0X5JffYFGxTSc8RW7c",
"signature": "d5db4371a0c2d7e17009dea8d53ecf15a7ec07b9",
"timestamp": 1626426833
}
}获取 IP 信息
php
\FresnsCmdWord::plugin('Fresns')->ipInfo($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| ip | String | YES | 支持 IPv4 和 IPv6 |
- 输出结果同 IP 信息接口
创建交互日志
php
\FresnsCmdWord::plugin('Fresns')->createSessionLog($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| type | Number | YES | 记录类型 |
| appId | String | NO | 密钥 App ID |
| platformId | Number | YES | 平台编号（配置表 platforms 键名的键值） |
| version | String | YES | 语义化版本号，例如: 2.0.0 |
| langTag | String | NO | 语言标签 |
| fskey | String | NO | 插件 Fskey |
| actionName | String | YES | 功能模型名或者接口路径 例如模型名 App\Models\Post 例如接口路径： /api/fresns/v1/account/auth-token |
| actionDesc | String | YES | 行为描述，自定义输入内容 |
| actionState | Number | YES | 1.未知或执行中 / 2.成功 / 3.失败 |
| actionId | String | NO | 例如发表行为，则代表发表内容的 ID 插件行为，凭此 ID 可查询对应插件那边记录的关联信息 |
| aid | String | NO | 账号 ID |
| uid | Number | NO | 用户 ID |
| deviceInfo | Object | NO | 交互设备信息 |
| deviceToken | String | NO | 交互设备 Token 例如 iOS Device Token 或 Android Device Token 可应用于推送消息 |
| loginToken | String | NO | 登录令牌 |
| moreInfo | Object | NO | 其他自定义信息 |
检测登录令牌 loginToken
php
\FresnsCmdWord::plugin('Fresns')->checkLoginToken($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| appId | String | YES | App ID |
| platformId | Number | YES | 平台编号（配置表 platforms 键名的键值） |
| version | String | YES | 语义化版本号，例如: 2.0.0 |
| loginToken | String | YES | 登录令牌 |
- 登录令牌由
createSessionLog命令字创建。
更新登录令牌 loginToken
php
\FresnsCmdWord::plugin('Fresns')->updateLoginToken($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| loginToken | String | YES | 登录令牌 |
| uid | Number | YES | 用户 ID |
| pin | String | NO | 用户 PIN Personal Identification Number |
- 当
checkLoginToken命令字结果状态为31604或31508使用31604用户需输入 PIN31508账户下有多个用户，需选择一个
- 如果不使用该命令字更新令牌信息，则该令牌不生效。
发送验证码
php
\FresnsCmdWord::plugin('Fresns')->sendCode($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| type | Number | YES | 类型：1.邮件验证码 / 2.短信验证码 |
| templateId | Number | YES | 验证码模板 ID |
| langTag | String | NO | 语言标签，留空则使用默认语言标签 |
| account | String | YES | 账号（邮箱或手机号） |
| countryCode | Number | NO | 国际区号（手机号专用） |
核对验证码
php
\FresnsCmdWord::plugin('Fresns')->checkCode($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| type | Number | YES | 类型：1.邮件验证码 / 2.短信验证码 |
| templateId | Number | YES | 验证码模板 ID |
| account | String | YES | 账号（邮箱或手机号） |
| countryCode | Number | NO | 国际区号（手机号专用） |
| verifyCode | String | YES | 验证码 |
更新或创建回调数据
php
\FresnsCmdWord::plugin('Fresns')->updateOrCreateCallbackContent($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| fskey | String | YES | 插件 Fskey |
| callbackKey | String | YES | 长度限制 64 字符 |
| callbackType | Number | NO | 参考 |
| callbackContent | Array | NO | |
| retentionDays | Number | NO | 默认 1 |
获取回调数据
php
\FresnsCmdWord::plugin('Fresns')->getCallbackContent($wordBody);| 参数名 | 类型 | 是否必传 | 说明 |
|---|---|---|---|
| fskey | String | YES | 插件 Fskey |
| callbackKey | String | YES | 长度限制 64 字符 |
| timeout | Number | NO | 单位：分钟 获取多少分钟内的数据 |
| markAsUsed | Boolean | NO | 默认 false |