1 概要
1.1 简介
商米数字店铺(SUNMI Store)中的合法用户可以拥有有指定组织下的员工身份。
2 接口规范
2.1 协议说明
对接的openAPI接口目前只开放HTTPS方式,所有的消息一律采用POST方式。
注:消息体大小不得超过1M,超过1M的请求,直接拒绝!
Content-Type | application/x-www-form-urlencoded |
---|---|
数据格式 | 返回为JSON格式 |
字符编码 | UTF-8字符编码 |
签名算法 | MD5 |
签名规则 | 参考2.2 签名规则 |
2.2 签名规则
参考《鉴权认证》文档。
2.3 公共参数
参数名 | 必填 | 类型 | 说明 | 示例 |
---|---|---|---|---|
app_id | 是 | string | 唯一标识接入身份,联系商米数字店铺提供 | LMWWQVTW4QGCC |
random | 是 | string | 随机字符串,由数字和字母组成,长度范围为6-10位 | 5dsf6698 |
timestamp | 是 | int | 当前的unix timestamp,精度到秒级,10位数字 | 1581333970 |
sign | 是 | string | 签名信息,详见2.2 | 2E7CED3164B6BBDB81145F3CBE204597 |
3 开放API接口
3.1 用户注册
接口描述:通过本接口调用,实现商米数字平台用户注册。
请求链接:/employee/create
接口版本:v1.0.0
接口参数:
参数名称 | 是否必须 | 类型 | 说明 | 示例 |
---|---|---|---|---|
user_id | 是 | string | user_id | |
sunmi_company_no | 是 | string | 商户编号 | |
name | 是 | int | 名称 | 1 |
number | 是 | string | 员工工号 | |
username | 是 | string | 员工账号(手机号/邮箱) | |
gender | 否 | string | 性别(男/女) | |
sso_username | 否 | string | 员工用户名(手机号) | |
mapping_list | 否 | string | 员工能管理的店铺列表 |
返回值:
{
"code": 0, /* 其他错误参考错误列表 */
"msg": "succeed",
"data": {}
}
错误码:
错误码 | 说明 |
---|---|
204 | 手机号码已经存在 |