Open-Agent-Api

1.1 创建用户

POST

/api/v2/employee/create

Employee

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Header 参数

channel

string

可选

默认值:

benlai

shopId

string

商城id

可选

默认值:

123

Body 参数application/json

employeeId

string

员工ID

必需

account

string

用户登陆账号

必需

employeeStatus

integer <int32>

员工状态

可选

1:在职
2:离职

name

string

姓名

可选

englishName

string

英文名

可选

phoneNumber

string

手机号

可选

string

邮箱

可选

gender

integer <int32>

性别

可选

1: 男, 2: 女

birthday

string <date-time>

出生日期

可选

格式：yyyy-MM-dd

hireDate

string <date-time>

入职时间

可选

格式：yyyy-MM-dd HH:mm:ss

regularizationDate

string <date-time>

转正时间

可选

格式：yyyy-MM-dd HH:mm:ss

terminationDate

string <date-time>

离职时间

可选

格式：yyyy-MM-dd HH:mm:ss

departmentCode

string

部门编码

可选

departmentName

string

部门名称

可选

jobTitle

string

岗位名称

可选

foreignEmployee

boolean

是否外籍员工

可选

true: 是, false: 否

password

string

用户初始密码

可选

示例

{
    "employeeId": "zs0001",
    "account": "zs-account",
    "employeeStatus": 1,
    "name": "张三",
    "englishName": "zhangsan",
    "phoneNumber": "138000456789",
    "email": "zhangsan@benlai.com",
    "birthday": "1988-03-22",
    "hireDate": "2024-08-24 18:15:22",
    "regularizationDate": "1988-03-22 20:00:00",
    "departmentCode": "sales",
    "departmentName": "Benlai",
    "jobTitle": "SE",
    "foreignEmployee": 0,
    "passwod": "2222222"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-agent-branch.benlai.com/api/v2/employee/create' \
--header 'channel: benlai' \
--header 'shopId: 123' \
--header 'Content-Type: application/json' \
--data-raw '{
    "employeeId": "zs0001",
    "account": "zs-account",
    "employeeStatus": 1,
    "name": "张三",
    "englishName": "zhangsan",
    "phoneNumber": "138000456789",
    "email": "zhangsan@benlai.com",
    "birthday": "1988-03-22",
    "hireDate": "2024-08-24 18:15:22",
    "regularizationDate": "1988-03-22 20:00:00",
    "departmentCode": "sales",
    "departmentName": "Benlai",
    "jobTitle": "SE",
    "foreignEmployee": 0,
    "passwod": "2222222"
}'

返回响应

🟢200成功

text/plain

Success

Body

employeeSysNo

integer <int32>

员工系统编号

可选

员工在本网的系统编号

示例

成功示例异常示例异常示例

{
    "code": 0,
    "msg": "",
    "value": {
        "employeeSysNo": 17729
    },
    "catId": "46826ea995ce94ba97d86efa0627f77a"
}

13.3 获取小类列表

1.3 处理用户变更