API文档

配置接口

接口列表

接口名称 接口方法 说明
1.查询门店配置 Config.GetOrgConfigs 查询门店配置，如早餐券成本单价
2.查询集团配置 Config.GetOwnerConfigs 查询集团配置，如会员级别
3.添加设备信息 Config.AddDevice 添加设备信息，如门锁
4.批量查询集团配置 Config.GetBulkOwnerConfig 批量查询集团配置，如预授权可用银行

1.查询门店配置

Config.GetOrgConfigs

应用场景

该接口用于获取门店配置的参数信息，可按照配置的分类名称及Key查询酒店的配置信息（如：早餐券售卖单价），具体分类及key值信息可以在pms系统-酒店信息维护-门店参数配置中查看

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id orgId 是 long
类别 Category 是 string 配置参数类别如：门店常用配置（OrgCommonConfig）
键 Key 否 string 如：早餐券成本单价（BreakfastTicketCostUnitPrice），具体配置名称可在酒店配置中查看，如果为空，则会查询分类（Category）下的所有的配置项

示例

 {
    "ChannelKey": "web",
    "Method": "Config.GetOrgConfigs",
    "BizContent": "{\"OrgId\":2147483644,\"Category\":\"HourRent\",\"Key\":\"Hour3\"}",
    "Sign": "8F3359FA0B7398EAF6E48A35B8D0B3D1",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
酒店Id OrgId 是 long
类别 Category 否 string
键 Key 否 string
配置的值 Value 否 bool
配置描述 Description 否 string

示例

{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": [
            {
                "OrgId": 2147483644,
                "Category": "HourRent",
                "Key": "Hour3",
                "Value": "DR,TR,TD",
                "Description": "时租三小时"
            }
        ]
}

2.查询集团配置

Config.GetOwnerConfigs

应用场景

该接口可按照配置的参数名称查询集团所有配置，具体分类及key值信息，可以在pms系统-系统设置-集团参数配置-系统参数维护中查看

请求参数

字段名 变量名 必填 类型 示例值 描述
类别 Category 是 string 参数类别业务配置如：业务逻辑配置（BusinessLogic）
键 Key 否 string 酒店最晚离店时间：LatestCheckoutTime，叫早提醒：MorningCallRemindAheadTimeSpan

示例

{
    "ChannelKey": "web",
    "Method": "Config.GetOwnerConfigs",
    "BizContent": "{\"Category\":\"BusinessLogic\",\"Key\":\"LatestCheckoutTime\"}",
    "Sign": "AE83F83532C2D01B108F4F0DA0CEB221",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

返回结果

字段名 变量名 必填 类型 示例值 描述
类别 Category 否 string
键 Key 否 string
配置的值 Value 否 bool
配置描述 Description 否 string

示例

{
        "Code": 10000,
        "Message": null,
        "SubCode": null,
        "SubMessage": null,
        "Data": [
            {
                "Category": "BusinessLogic",
                "Key": "LatestCheckoutTime",
                "Value": "12:00",
                "Description": "最晚离店时间"
            }
        ]
}

3.添加设备信息

Config.AddDevice

应用场景

该接口用来添加门锁、插件等设备的配置信息

请求参数

字段名 变量名 必填 类型 示例值 描述
酒店Id orgId 是 long 和其它字段组合为唯一约束条件
设备型号 Sn 否 string 老版插件使用，见字典“门锁类型”
品牌名称 Name 否 string 老版插件使用
版本 Version 是 string 和其它字段组合为唯一约束条件
类别 Category 是 string 和其它字段组合为唯一约束条件 见字典“设备类型”
品牌 Brand 是 string 和其它字段组合为唯一约束条件
型号 Model 是 string 和其它字段组合为唯一约束条件
配置信息 Config 否 string
插件版本标识 PluginVersionId 否 string “New”表示新插件
有效期开始时间 BeginTime 否 DateTime 2017-11-16 13:30:00
有效期结束时间 EndTime 否 DateTime 2017-11-16 13:30:00

示例

 
{
    "ChannelKey": "web",
    "Method": "Config.AddDevice",
    "BizContent": "{\"OrgId\":2147483644,\"Version\":\"2.1\",\"Category\":\"MeituanLock\",\"Brand\":\"美团网络门锁\",\"Model\":\"2300\"}",
    "Sign": "B689DB5FD3DB4C12F857B0776A02D2E6",
    "SignType": "MD5",
    "Format": "json",
    "Charset": "utf-8",
    "Version": "1.0",
    "Timestamp": "2017-11-16 10:12:13"
}

返回结果

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

示例

        
        {
            "Code": 10000,
            "Message": null,
            "SubCode": null,
            "SubMessage": null,
            "Data": 776062991171593
        }

4.批量查询集团配置

Config.GetBulkOwnerConfig

应用场景

用来查询预授权可使用的银行信息

请求参数

字段名 变量名 必填 类型 示例值 描述
配置类别 Category 是 string 目前只支持Bank

示例

 
    {
        "ChannelKey": "web",
        "Method": "Config.GetBulkOwnerConfig",
        "BizContent": "{\"Category\":\"Bank\"}",
        "Sign": "4776AF70DF9140AC334DD328C852252F",
        "SignType": "MD5",
        "Format": "json",
        "Charset": "utf-8",
        "Version": "1.0",
        "Timestamp": "2020-08-10 14:56:09"
    }

返回结果

字段名 变量名 必填 类型 示例值 描述
类别 Category 否 string
键 Key 否 string
配置的值 Value 否 bool
配置描述 Description 否 string

示例

    {
            "Code": 10000,
            "Message": null,
            "SubCode": null,
            "SubMessage": null,
            "Data": [
                {
                    "Category": "BusinessLogic",
                    "Key": "LatestCheckoutTime",
                    "Value": "12:00",
                    "Description": "最晚离店时间"
                }
            ]
    }