Skip to content
On this page

User Auth

  • Endpoint Path: /api/v2/user/auth
  • Method: POST
  • Request: application/json

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)
X-Fresns-Aidrequiredrequired
X-Fresns-Aid-Tokenrequiredrequired
X-Fresns-Uidoptionaloptional
X-Fresns-Uid-Tokenoptionaloptional

Body Params

Parameter NameTypeRequiredDescription
uidOrUsernameStringrequired用户 uid 或者 username
passwordStringoptional密码(以 Base64 传参)
deviceTokenStringoptionaliOS 或 Android 设备 Token

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "sessionToken": {
            "token": "String / 用户登录凭证",
            "expiredHours": "Number / 有效期小时数,null 代表永久有效",
            "expiredDays": "Number / 有效期天数,null 代表永久有效",
            "expiredDateTime": "String / 凭证有效时间,null 代表永久有效,格式为 Y-m-d H:i:s"
        },
        "detail": {
            // Common Data Structure -> User Info
        }
    }
}

Released under the Apache-2.0 License