用户登录 - fresns

请求参数

Header 参数

X-Fresns-App-Id

string

必需

密钥 App ID
密钥位置：控制面板->应用中心->应用密钥

默认值:

X-Fresns-Client-Platform-Id

integer

必需

平台编号，与密钥的「平台」匹配

默认值:

X-Fresns-Client-Version

string

必需

你的客户端版本号，推荐使用语义化版本号

默认值:

X-Fresns-Client-Device-Info

string

必需

交互设备信息 session_logs > device_info
压缩 Object 信息为字符串传参

默认值:

X-Fresns-Aid

string

可选

账号参数（留空则视为未登录账号）

默认值:

X-Fresns-Aid-Token

string

可选

账号身份凭证（传参 aid 时必传）

默认值:

X-Fresns-Uid

integer

可选

用户参数（留空则视为未登录用户）

默认值:

X-Fresns-Uid-Token

string

可选

用户身份凭证（传参 uid 时必传）

默认值:

X-Fresns-Signature

string

签名

必需

X-Fresns-Signature-Timestamp

string

必需

签名生成时间（当前 Unix 时间戳，精确到秒或毫秒都支持）

Body 参数application/json

uidOrUsername

string

必需

用户 uid 或者 username

password

string

可选

密码（以 Base64 传参）

deviceToken

string

可选

iOS 或 Android 设备 Token

示例

{
    "uidOrUsername": "string",
    "password": "string",
    "deviceToken": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

sessionToken

object (SessionToken)

必需

detail

object (User)

必需

示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "sessionToken": {
            "token": "Amw9s9uSxJz5aKNj1lG22ysU2wR4v0Tf",
            "expiredHours": null,
            "expiredDays": null,
            "expiredDateTime": null
        },
        "detail": {
            "fsid": "admin",
            "uid": 11182,
            "username": "admin",
            "url": "/u/admin",
            "nickname": "Admin",
            "avatar": "http://localhost:8080/static/images/default-avatar.png",
            "decorate": null,
            "banner": null,
            "gender": 1,
            "birthday": null,
            "bio": null,
            "location": null,
            "conversationLimit": 1,
            "commentLimit": 1,
            "timezone": "+8",
            "verifiedStatus": false,
            "verifiedIcon": null,
            "verifiedDesc": null,
            "verifiedDateTime": null,
            "expired": false,
            "expiryDateTime": null,
            "lastPublishPost": null,
            "lastPublishComment": null,
            "lastEditUsername": null,
            "lastEditNickname": null,
            "registerDate": "2023-03-19 12:47:04",
            "hasPassword": false,
            "rankState": 1,
            "status": true,
            "waitDelete": false,
            "waitDeleteDateTime": null,
            "bioHtml": "",
            "nicknameColor": null,
            "rid": 1,
            "roleName": "管理员",
            "roleNameDisplay": false,
            "roleIcon": null,
            "roleIconDisplay": false,
            "roleExpiryDateTime": null,
            "roleRankState": 1,
            "rolePermissions": {
                "rid": 1,
                "content_view": true,
                "conversation": true,
                "content_link_handle": 3,
                "post_publish": true,
                "post_review": false,
                "post_email_verify": false,
                "post_phone_verify": false,
                "post_real_name_verify": false,
                "post_limit_status": false,
                "post_limit_type": 1,
                "post_limit_period_start": "2022-06-01 22:30:00",
                "post_limit_period_end": "2022-06-06 08:00:00",
                "post_limit_cycle_start": "23:00:00",
                "post_limit_cycle_end": "08:30:00",
                "post_limit_rule": 1,
                "post_second_interval": 60,
                "post_draft_count": 10,
                "comment_publish": true,
                "comment_review": false,
                "comment_email_verify": false,
                "comment_phone_verify": false,
                "comment_real_name_verify": false,
                "comment_limit_status": false,
                "comment_limit_type": 1,
                "comment_limit_period_start": "2022-06-01 22:30:00",
                "comment_limit_period_end": "2022-06-06 08:00:00",
                "comment_limit_cycle_start": "23:00:00",
                "comment_limit_cycle_end": "08:30:00",
                "comment_limit_rule": 1,
                "comment_second_interval": 60,
                "comment_draft_count": 10,
                "post_editor_image": true,
                "post_editor_image_upload_number": 9,
                "post_editor_video": true,
                "post_editor_video_upload_number": 1,
                "post_editor_audio": true,
                "post_editor_audio_upload_number": 2,
                "post_editor_document": true,
                "post_editor_document_upload_number": 10,
                "comment_editor_image": true,
                "comment_editor_image_upload_number": 9,
                "comment_editor_video": false,
                "comment_editor_video_upload_number": 1,
                "comment_editor_audio": false,
                "comment_editor_audio_upload_number": 2,
                "comment_editor_document": false,
                "comment_editor_document_upload_number": 10,
                "image_max_size": 5,
                "video_max_size": 50,
                "video_max_time": 60,
                "audio_max_size": 50,
                "audio_max_time": 60,
                "document_max_size": 10,
                "follow_user_max_count": 500,
                "block_user_max_count": 500,
                "download_file_count": 10
            },
            "roleStatus": true,
            "stats": {
                "likeUserCount": null,
                "likeGroupCount": null,
                "likeHashtagCount": null,
                "likePostCount": null,
                "likeCommentCount": null,
                "dislikeUserCount": null,
                "dislikeGroupCount": null,
                "dislikeHashtagCount": null,
                "dislikePostCount": null,
                "dislikeCommentCount": null,
                "followUserCount": 0,
                "followGroupCount": 0,
                "followHashtagCount": null,
                "followPostCount": null,
                "followCommentCount": null,
                "blockUserCount": null,
                "blockGroupCount": null,
                "blockHashtagCount": null,
                "blockPostCount": null,
                "blockCommentCount": null,
                "likeMeCount": 0,
                "dislikeMeCount": null,
                "followMeCount": 0,
                "blockMeCount": null,
                "postPublishCount": 0,
                "postDigestCount": 0,
                "postLikeCount": 0,
                "postDislikeCount": null,
                "postFollowCount": 0,
                "postBlockCount": null,
                "commentPublishCount": 0,
                "commentDigestCount": 0,
                "commentLikeCount": 0,
                "commentDislikeCount": null,
                "commentFollowCount": 0,
                "commentBlockCount": null,
                "extcredits1": null,
                "extcredits1Status": 1,
                "extcredits1Name": null,
                "extcredits1Unit": null,
                "extcredits2": null,
                "extcredits2Status": 1,
                "extcredits2Name": null,
                "extcredits2Unit": null,
                "extcredits3": null,
                "extcredits3Status": 1,
                "extcredits3Name": null,
                "extcredits3Unit": null,
                "extcredits4": null,
                "extcredits4Status": 1,
                "extcredits4Name": null,
                "extcredits4Unit": null,
                "extcredits5": null,
                "extcredits5Status": 1,
                "extcredits5Name": null,
                "extcredits5Unit": null
            },
            "archives": [],
            "operations": {
                "customizes": [],
                "buttonIcons": [],
                "diversifyImages": [],
                "tips": []
            },
            "extends": {
                "textBox": [],
                "infoBox": [],
                "interactionBox": []
            },
            "roles": [
                {
                    "rid": 1,
                    "isMain": true,
                    "nicknameColor": null,
                    "name": "管理员",
                    "nameDisplay": false,
                    "icon": null,
                    "iconDisplay": false,
                    "expiryDateTime": null,
                    "rankState": 1,
                    "status": true
                }
            ],
            "interaction": {
                "userName": "用户",
                "userUidName": "用户号",
                "userUsernameName": "用户名",
                "userNicknameName": "昵称",
                "userRoleName": "角色",
                "userBioName": "简介",
                "followSetting": true,
                "followName": "关注",
                "likeSetting": false,
                "likeName": "喜欢",
                "dislikeSetting": false,
                "dislikeName": "不喜欢",
                "blockSetting": false,
                "blockName": "拉黑",
                "publishPostName": "发帖",
                "publishCommentName": "回复",
                "likeStatus": false,
                "dislikeStatus": false,
                "followStatus": false,
                "followMeStatus": false,
                "followNote": null,
                "followExpired": false,
                "followExpiryDateTime": null,
                "blockStatus": false,
                "blockMeStatus": false,
                "blockNote": null
            },
            "conversation": {
                "status": false,
                "code": 31601,
                "message": "用户未登录，无权操作"
            }
        }
    }
}