文档
测试

1.1登录

POST
login

接口描述

收银员登录,登录后,返回登录 TOKEN、收银员和商户信息,可缓存本地后续使用,其中是 TOKEN在之后任何接口请求都要传入带上。

请求参数

参数名
类型
描述
必填
username
String
用户名,为手机号格式,如:13800001111
必填
password
String
密码
必填
sn
String
设备SN,有传入,将会验证设备是否与登录用户同属于一个门店
可选

响应参数

参数名
类型
描述
必填
code
int
错误码,成功返回 200,失败返回其它,具体可参考本文档「错误码」章节
必填
message
String
错误描述,成功返回sucess,否则其它具体错误描述
必填
data
Object
对象,业务数据
必填
token
String
登录成功身份TOKEN
必填
employee
Object
收银员对象,登录成功时有返回
必填
employee_code
Sttring
收银员登录帐号/用户号
必填
employee_id
Long
收银员 ID
必填
employee_name
String
收银员姓名
必填
outlet
Object
登录商户对象,登录成功时有返回
必填
appid
String
商户APPID
必填
outlet_name
String
商户名称
必填
outlet_id
Long
商户 ID
必填
outlet_code
String
商户编号
必填
timestamp
Long
登录时间戳(毫秒级),也是服务器时间
必填
service_phone
String
服务电话
必填
consume_mode
String
202404增加,消费模式:AMOUNT为计费模式,COUNT为计次模式,下为为空表示计费模式
必填

说明 / 示例

### 请求示例 ``` https://api2.XXX.cn/cm/login?userid=138000011111&password=888888 ``` ==注意:POST提交,示例仅演示参数== ### 返回示例 #### 成功返回 JSON ``` { "code": 200, "message": "success", "data": { "employee": { "employee_id": 10, "employee_code": "17359287910", "employee_name": "老郑" }, "outlet": { "appid": "jb8ca19c66039e56f0", "outlet_id": 34000, "outlet_name": "食堂ZERO" }, "token": "816FF0F2D9953372943E7411666B37EB", "consume_mode": "AMOUNT" } } ``` #### 失败返回 JSON ``` { "code": 107, "message": "system.error.missingServletRequestParameter" } ``` ==system.error.missingServletRequestParameter== 参数缺少,如没有password参数,或书写错误 #### 失败返回 JSON ``` { "code": 5001, "message": "密码错误" } ``` 收银员登录密码错误