Skip to content
On this page

Basic Command Word

verifySign

php
\FresnsCmdWord::plugin('Fresns')->verifySign($wordBody)
Parameter NameTypeRequiredDescription
platformIdNumberrequired平台编号(配置表 platforms 键名的键值)
versionStringrequired语义化版本号
appIdStringrequiredApp ID
timestampNumberrequired签名生成时间(当前 Unix 时间戳,精确到秒或毫秒都支持)
signStringrequired请求签名
aidStringoptional账号参数(账号主表 accounts > aid 字段)
aidTokenStringoptional账号身份凭证
uidNumberoptional用户参数(用户主表 users > uid 字段)
uidTokenStringoptional用户身份凭证

verifyUrlSign

php
\FresnsCmdWord::plugin('Fresns')->verifyUrlSign($wordBody)
Parameter NameTypeRequiredDescription
urlSignStringrequired参见:为插件生成签名
逻辑说明

用户将通过 URL 访问插件页面,URL 中会传参签名信息,用于一键登录。

  • 1、先使用 URL Encode 解码 {urlSign} 变量名的值,得到 base64 加密字符串
  • 2、再使用 base64 解密字符串,得到 json object 格式的 header 数据(包括 MD5 签名)
    • 可以留空或不传的参数:langTagtimezoneuiddeviceInfo
    • uid 不传,则表示为账号身份登录。
  • 3、获取 headers 中生成签名的信息,校验签名是否正确,正确则 code 为 0
  • 4、无论是否正确,都输出 headers 信息,格式见下方Return Example。
Return Example
json
{
    "code": 0,
    "message": "ok",
    "data": {
        "platformId": 4,
        "version": "1.0.0",
        "appId": "qe12345",
        "timestamp": 1626426833,
        "sign": "d5db4371a0c2d7e17009dea8d53ecf15a7ec07b9",
        "langTag": "zh-Hans",
        "timezone": "+8",
        "aid": "6a3bb3bc",
        "aidToken": "uoX1hk6SHUgB2MFGJwNx38dem9DA7Vsz",
        "uid": 782622,
        "uidToken": "PqBpwPLJgfd1sH0X5JffYFGxTSc8RW7c",
        "deviceInfo": ""
    }
}

uploadSessionLog

php
\FresnsCmdWord::plugin('Fresns')->uploadSessionLog($wordBody)
Parameter NameTypeRequiredDescription
typeNumberrequired记录类型
platformIdNumberrequired平台编号(配置表 platforms 键名的键值)
versionStringrequired语义化版本号,例如: 2.0.0
appIdStringoptional密钥 App ID
langTagStringoptionalLanguage Tag
pluginUnikeyStringoptional插件 Unikey
aidStringoptional账号
uidNumberoptional用户
objectNameStringrequired功能模型名或者接口路径
例如模型名 App\Models\Post
例如接口路径:/api/v2/account/login
objectActionStringrequired行为描述,自定义输入内容
objectResultNumberrequired1.未知或执行中 / 2.成功 / 3.失败
objectOrderIdStringoptional例如发表行为,则代表发表内容的 ID
插件行为,凭此 ID 可查询对应插件那边记录的关联信息
deviceInfoObjectoptional交互设备信息
deviceTokenStringoptional交互设备 Token
例如 iOS Device Token 或 Android Device Token
可应用于推送消息
moreJsonObjectoptional其他自定义信息

sendCode

php
\FresnsCmdWord::plugin('Fresns')->sendCode($wordBody)
Parameter NameTypeRequiredDescription
typeNumberrequired类型:1.邮件验证码 / 2.短信验证码
accountStringrequired账号(邮箱或手机号)
countryCodeNumberoptional国际区号(手机号专用)
templateIdNumberrequired验证码模板 ID
langTagStringrequiredLanguage Tag

checkCode

php
\FresnsCmdWord::plugin('Fresns')->checkCode($wordBody)
Parameter NameTypeRequiredDescription
typeNumberrequired类型:1.邮件验证码 / 2.短信验证码
accountStringrequired账号(邮箱或手机号)
countryCodeNumberoptional国际区号(手机号专用)
verifyCodeStringrequired验证码
templateIdNumberrequired验证码模板 ID

ipInfo

php
\FresnsCmdWord::plugin('Fresns')->ipInfo($wordBody)
Parameter NameTypeRequiredDescription
ipv4Stringoptional
ipv6Stringoptional

Released under the Apache-2.0 License