API文档

系统用户接口

接口列表

接口名称 接口方法 说明
1.查询所有角色信息 Security.GetRoles 查询集团下所有角色信息
2.PMS登录授权 Security.LoginPms 使用用户名和密码登录PMS
3.根据SessionId获取用户信息 Security.GetUserBySessionId 根据SessionId获取用户信息

1.查询所有角色信息

Security.GetRoles

应用场景

查询集团下所有角色信息

请求参数

字段名 变量名 必填 类型 示例值 描述

示例

                
                    {
                    "ChannelKey": "web",
                    "Method": "Security.GetRoles",
                    "BizContent": "",
                    "Sign": "687428C47A25C545B54D7ECBF8F29AEC",
                    "SignType": "MD5",
                    "Format": "json",
                    "Charset": "utf-8",
                    "Version": "1.0",
                    "Timestamp": "2018-08-06 18:12:13"
                    }

返回结果

字段名 变量名 必填 类型 示例值 描述
RoleId 角色ID 是 string 10
RoleName 角色名称 是 string 酒店前台

示例

    
{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": [
            {
            "RoleId": "10",
            "RoleName": "酒店前台"
            },
            {
            "RoleId": "11",
            "RoleName": "客房主管"
            }
        ]
}

2.PMS登录授权

Security.LoginPms

应用场景

第三登录跳转到PMS

请求参数

字段名 变量名 必填 类型 示例值 描述
用户名 UserName 是 string
密码 Password 是 string
登录门店 OrgId 否 long

示例

                
                      {
                "ChannelKey": "web",
                "Method": "Security.LoginPms",
                "BizContent": "{\"UserName\":\"zhagnsan\",\"Password\":\"zhangsan123\"}",
                "Sign": "F5AC097899A944677F05C56C6E27863C",
                "SignType": "MD5",
                "Format": "json",
                "Charset": "utf-8",
                "Version": "1.0",
                "Timestamp": "2018-08-06 18:12:13"
                }

返回结果

字段名 变量名 必填 类型 示例值 描述
Token Token 是 string openapi|1|11db7097-2847-45d8-b496-2d1199b0cce4 登录PMS携带标识

示例

    
{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Sign": "",
    "Data": {
        "Token": "openapi|1|11db7097-2847-45d8-b496-2d1199b0cce4"
       
    }
}

3.根据SessionId获取用户信息

Security.GetUserBySessionId

应用场景

可用来判断是否登录

请求参数

字段名 变量名 必填 类型 示例值 描述
SessionId SessionId 是 string
登录门店 OrgId 否 long

示例

                
                   {
                "ChannelKey": "web",
                "Method": "Security.GetUserBySessionId",
                "BizContent": "{\"SessionId\":\"1|c3VwZXJhZG1pbg|3BFBF2FF-1C07-4D91-945C-FC35C7263593\"}",
                "Sign": "386D2F35AD0A73524928896C5C40CCFE",
                "SignType": "MD5",
                "Format": "json",
                "Charset": "utf-8",
                "Version": "1.0",
                "Timestamp": "2018-08-06 18:12:13"
                }

返回结果

字段名 变量名 必填 类型 示例值 描述
Token Token 是 string openapi|1|11db7097-2847-45d8-b496-2d1199b0cce4 登录PMS携带标识

示例

    
{
    "Code": 10000,
    "Message": null,
    "SubCode": null,
    "SubMessage": null,
    "Sign": "",
    "Data": {
        "UserName": "zhangsan"
    }
}