如果有其他接口需求,或者有不明白的,请发邮件至39141862@qq.com
获取AccessToken
获取access_token是调API接口的第一步,相当于创建了一个登录凭证,其它的业务API接口,都需要依赖于access_token来鉴权调用者身份。
因此开发者,在使用业务接口前,需要获取access_token。
- URL:
/information/createaccesstoken - Method:
POST请求参数
:::info 💡 注意,corpid和secret在 企业管理-企业设置 中获取 ::: | 参数 | 类型 | | —- | —- | | corpid | String | | secret | String |
请求示例
可以仅传递部分请求参数。
{"corpid": "b5c9a0b0-d7be-4e4b-b057-c94b1de3c77d","secret": "ea106dc2fe4a3cc47d57e8688c9c4c2607aad5e8"}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{"code": 0,"msg": "ok","data": {"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MCwic2VsZl91c2VyaWQiOiIiLCJuaWNrX25hbWUiOiIiLCJuYW1lIjoiIiwiY29ycGlkIjoiMzc0ZjUxNjctNTNmZC00MWU0LWJhYjItYTI2MjUxODllMTA3IiwicGVybWlzc2lvbiI6IiIsImFjdGl2ZSI6ZmFsc2UsImRlcGFydF9pbmZvIjpudWxsLCJyZWZyZXNoX3Rva2VuIjpmYWxzZSwiand0X3Blcm1pc3Npb24iOjEsImV4cCI6MTY1Mzk4NjM2NiwibmJmIjoxNjUzOTc4NTY2fQ.Imeq0iliFy0MfDX3xiVzaOzZ6BIduqr3UcQhOncXY9s","expired": 1653986366 //过期时间}}
获取角色列表
请求示例
可以仅传递部分请求参数。
{"corpid":"374f5167-53fd-41e4-bab2-a2625189e107"}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{"code": 0,"msg": "ok","data": [{"RoleGroup": {"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","group_id": 1,"group_name": "职务","order_id": 1},"Roles": [{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 1,"role_name": "财务","role_group_id": 1},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 2,"role_name": "人事","role_group_id": 1},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 3,"role_name": "出纳","role_group_id": 1},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 4,"role_name": "销售","role_group_id": 1},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 5,"role_name": "客服","role_group_id": 1},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 6,"role_name": "质检","role_group_id": 1},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 7,"role_name": "研发","role_group_id": 1},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 8,"role_name": "行政","role_group_id": 1},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 9,"role_name": "设计","role_group_id": 1},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 10,"role_name": "产品","role_group_id": 1}]},{"RoleGroup": {"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","group_id": 2,"group_name": "岗位","order_id": 2},"Roles": [{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 11,"role_name": "普通员工","role_group_id": 2},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 12,"role_name": "经理","role_group_id": 2},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 13,"role_name": "科长","role_group_id": 2},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 14,"role_name": "部长","role_group_id": 2},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 15,"role_name": "总监","role_group_id": 2},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 16,"role_name": "管理层","role_group_id": 2},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 17,"role_name": "高级管理者","role_group_id": 2},{"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","role_id": 18,"role_name": "总经理","role_group_id": 2}]}]}
增加一个角色
- URL:
org/role/addrole - Method:
POST请求参数
| 参数 | 类型 | 描述 | | —- | —- | —- | | name | String | 角色名 | | group_id | int | 分组id |
请求示例
可以仅传递部分请求参数。
{"name":"角色2","group_id":1}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{"code": 0,"msg": "ok","data": 24 //角色id}
删除一个角色
请求示例
可以仅传递部分请求参数。
{"role_id":24}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{"code": 0,"msg": "ok","data": null}
编辑角色
- URL:org/role/editrole
- Method:
POST请求参数
| 参数 | 类型 | 描述 | | —- | —- | —- | | role_id | int | 角色id | | name | string | 角色名 |
请求示例
可以仅传递部分请求参数。
{"role_id":24,"name":"1232",}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{"code": 0,"msg": "ok","data": null}
增加一个部门
- URL:org/depart/add
- Method:
POST请求参数
| 参数 | 类型 | 描述 | | —- | —- | —- | | parent_id | int | 父部门id | | depart_name | string | 部门名 |
请求示例
可以仅传递部分请求参数。
{"parent_id":1,"depart_name":"1232",}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{"code": 0,"msg": "ok","data": null}
编辑一个部门
- URL:org/depart/edit
- Method:
POST请求参数
| 参数 | 类型 | 描述 | | —- | —- | —- | | department_id | int | 部门id | | depart_name | string | 修改的部门名 | | parent_id | int | 修改的父部门 |
请求示例
可以仅传递部分请求参数。
{"parent_id":1,"depart_name":"1232","department_id":2}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{"code": 0,"msg": "ok","data": null}
删除一个部门
- URL:org/depart/remove
- Method:
POST请求参数
| 参数 | 类型 | 描述 | | —- | —- | —- | | department_id | int | 部门id |
请求示例
可以仅传递部分请求参数。
{"department_id":2}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{"code": 0,"msg": "ok","data": null}
部门列表
请求示例
可以仅传递部分请求参数。
{"corpid":"374f5167-53fd-41e4-bab2-a2625189e107"}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{"code": 0,"msg": "ok","data": [{"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","depart_name": "1232","department_id": 2,"parent_id": 1,"has_sub": true,"count": 0},{"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","depart_name": "123","department_id": 3,"parent_id": 1,"has_sub": true,"count": 0},{"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","depart_name": "1232","department_id": 4,"parent_id": 1,"has_sub": true,"count": 0}]}
子部门列表
请求示例
可以仅传递部分请求参数。
{"department_id":4,}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{"code": 0,"msg": "ok","data": [{"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","depart_name": "1232","department_id": 2,"parent_id": 1,"has_sub": true,"count": 0},{"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","depart_name": "123","department_id": 3,"parent_id": 1,"has_sub": true,"count": 0},{"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","depart_name": "1232","department_id": 4,"parent_id": 1,"has_sub": true,"count": 0}]}
部门详情
- URL:org/depart/departbyid
- Method:
POST请求参数
| 参数 | 类型 | 描述 | | —- | —- | —- | | department_id | int |
|
请求示例
可以仅传递部分请求参数。
{"department_id":4,}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{"code": 0,"msg": "ok","data": {"id": 0,"created_on": 0,"modified_on": 0,"corpid": "374f5167-53fd-41e4-bab2-a2625189e107","department_id": 3,"parent_id": 1,"depart_name": "123","depart_name_pinyin": "123"}}
增加一个用户
- URL:org/user/add
- Method:
POST请求参数
| 参数 | 类型 | 描述 | | —- | —- | —- | | userid | string | 必填 | | mobile | string | 必填 | | nick_name | string | | | name | string | | | email | string | | | position | string | 职务 | | department_ids | []int | 所在部门 | | manager_depart_ids | []int | 管理部门 | | main_depart_id | int | 主部门 | | role_ids | []int | 角色列表 |
请求示例
可以仅传递部分请求参数。
{"userid": "20210821","mobile":"15312341234","nick_name": "ccc","email":"","position":"","name": "ssss","department_ids": [ 1 ],"manager_depart_ids": [ 1 ],"role_ids": [ 1 ],"main_depart_id": 1}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{
"code": 0,
"msg": "ok",
}
删除用户
请求示例
可以仅传递部分请求参数。
{
"userid":["20210821"],
}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{
"code": 0,
"msg": "ok",
}
编辑用户
- URL:org/user/update
- Method:
POST请求参数
| 参数 | 类型 | 描述 | | —- | —- | —- | | id | int | | | userid | string | 必填 | | mobile | string | 必填 | | nick_name | string | | | name | string | | | email | string | | | position | string | 职务 | | department_ids | []int | 所在部门 | | manager_depart_ids | []int | 管理部门 | | main_depart_id | int | 主部门 | | role_ids | []int | 角色列表 |
请求示例
可以仅传递部分请求参数。
{
"id":17,
"userid": "20210821",
"mobile":"15312341234",
"nick_name": "ccc",
"email":"",
"position":"",
"name": "ssss",
"department_ids": [ 1 ],
"manager_depart_ids": [ 1 ],
"role_ids": [ 1 ],
"main_depart_id": 1
}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{
"code": 0,
"msg": "ok",
}
获取部门下所有用户
- URL:org/user/listbydepartid
- Method:
POST请求参数
| 参数 | 类型 | 描述 | | —- | —- | —- | | department_id | int |
| | page_size | int | 单页数量 | | page_index | int | 第几页 |
请求示例
可以仅传递部分请求参数。
{
"department_id": 1,
"page_size": 10,
"page_index": 1
}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{
"code": 0,
"msg": "ok",
"data": {
"count": 6, //所有用户数量
"list": [
{
"id": 9,
"created_on": 0,
"modified_on": 0,
"corpid": "374f5167-53fd-41e4-bab2-a2625189e107",
"userid": "202108309",
"nick_name": "测试111122",
"name": "",
"gender": 0,
"passwd": "",
"email": "",
"email_verified": false,
"mobile": "15384087113",
"auth_data": null,
"permission": 0,
"nick_name_pinyin": "",
"name_pinyin": "",
"created": false,
"remark": "",
"position": "",
"active": false,
"banned": false,
"sync_del": false
},
{
"id": 39,
"created_on": 0,
"modified_on": 0,
"corpid": "374f5167-53fd-41e4-bab2-a2625189e107",
"userid": "20201234",
"nick_name": "summer_ness",
"name": "",
"gender": 0,
"passwd": "",
"email": "",
"email_verified": false,
"mobile": "15384087112",
"auth_data": null,
"permission": 0,
"nick_name_pinyin": "",
"name_pinyin": "",
"created": false,
"remark": "",
"position": "",
"active": false,
"banned": false,
"sync_del": false
},
{
"id": 176,
"created_on": 0,
"modified_on": 0,
"corpid": "374f5167-53fd-41e4-bab2-a2625189e107",
"userid": "1233",
"nick_name": "123",
"name": "",
"gender": 0,
"passwd": "",
"email": "",
"email_verified": false,
"mobile": "15140438638",
"auth_data": null,
"permission": 0,
"nick_name_pinyin": "",
"name_pinyin": "",
"created": false,
"remark": "",
"position": "",
"active": false,
"banned": false,
"sync_del": false
},
{
"id": 325,
"created_on": 0,
"modified_on": 0,
"corpid": "374f5167-53fd-41e4-bab2-a2625189e107",
"userid": "111111",
"nick_name": "lyt",
"name": "",
"gender": 0,
"passwd": "",
"email": "",
"email_verified": false,
"mobile": "15140438637",
"auth_data": null,
"permission": 0,
"nick_name_pinyin": "",
"name_pinyin": "",
"created": false,
"remark": "",
"position": "",
"active": false,
"banned": false,
"sync_del": false
},
{
"id": 326,
"created_on": 0,
"modified_on": 0,
"corpid": "374f5167-53fd-41e4-bab2-a2625189e107",
"userid": "519",
"nick_name": "ys",
"name": "",
"gender": 0,
"passwd": "",
"email": "",
"email_verified": false,
"mobile": "15140550802",
"auth_data": null,
"permission": 0,
"nick_name_pinyin": "",
"name_pinyin": "",
"created": false,
"remark": "",
"position": "",
"active": false,
"banned": false,
"sync_del": false
},
{
"id": 330,
"created_on": 0,
"modified_on": 0,
"corpid": "374f5167-53fd-41e4-bab2-a2625189e107",
"userid": "20210821",
"nick_name": "ccc",
"name": "ssss",
"gender": 0,
"passwd": "",
"email": "",
"email_verified": false,
"mobile": "15312341234",
"auth_data": null,
"permission": 0,
"nick_name_pinyin": "",
"name_pinyin": "",
"created": false,
"remark": "",
"position": "",
"active": false,
"banned": false,
"sync_del": false
}
]
}
}
增加一条数据
暂时只可以增加数字、字符控件的值,如果涉及需要请求下拉表单、关联表单等这种需要下拉选择的控件,请联系:39141862@qq.com
- URL:page/insertonedata
- Method:
POST请求参数
| 参数 | 类型 | 描述 | | —- | —- | —- | | page_code | string | 表单code | | app_code | string | 应用code | | page_type | int | 该表单的type(0.普通表单,3.流程表单) | | field_data_list | array | 数据体 | | field_data_list.field_key | string | 控件key | | field_data_list.field_data | string | 该控件的值 | | sub_data_list.sub_data_list | array | 子表单数据体 | | sub_data_list.sub_data_list.field_key | string | 子表单的key | | sub_data_list.sub_data_list.sub_field_key | string | 子表单里控件的key | | sub_data_list.sub_data_list.sub_data_key | string | 子表单里某一条的key | | sub_data_list.sub_data_list.sub_field_data | string | 子表单控件的值 |
请求示例
可以仅传递部分请求参数。
{
"page_code": "0973f59e-c502-4f29-8275-d8bc9a81fc28",
"app_code": "212dd3f8-16db-45e0-bce0-8fc0542e73d8",
"field_data_list": [
{
"field_key": "220f2fc1-ce19-4171-b5cf-860cc969ed46",
"field_data": "1232"
},
{
"field_key": "00530aef-5745-49a6-853e-4b545e1ca8db",
"field_data": "12322"
},
{
"field_key": "c9185187-bcb7-4770-93f7-56f96a7ee266",
"field_data": "1232022-05-1800002"
},
{
"field_key": "0bd6320d-e7df-4785-9255-3b82d7a6ab5f",
"field_data": "",
"sub_data_list": [
{
"field_key": "0bd6320d-e7df-4785-9255-3b82d7a6ab5f",
"sub_field_key": "961f891a-a6b0-4e28-98b0-b68984b7b2f4",
"sub_data_key": "125f18db-685d-4672-a8c9-3f73ff0fe933",
"sub_field_data": "1111"
},
{
"field_key": "0bd6320d-e7df-4785-9255-3b82d7a6ab5f",
"sub_field_key": "961f891a-a6b0-4e28-98b0-b68984b7b2f4",
"sub_data_key": "efb17359-b647-43c0-9bb1-e70d5a5e84c6",
"sub_field_data": "2222"
},
{
"field_key": "0bd6320d-e7df-4785-9255-3b82d7a6ab5f",
"sub_field_key": "961f891a-a6b0-4e28-98b0-b68984b7b2f4",
"sub_data_key": "f3487184-15b8-4a7b-9154-795d773f5881",
"sub_field_data": "3333"
}
]
}
],
"page_type": 3,
}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{
"code":0,
"msg":"ok",
"data":"bacab03c-5212-419f-959d-7d328993a37d" //这一条数据的code
}
某一条数据详情
请求示例
可以仅传递部分请求参数。
{
"code": "212dd3f8-16db-45e0-bce0-8fc0542e73d8"
}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{
"base_info": { // 基础信息
"create_by": "202108309",
"created_on": 1653989953522,
"depart_id": 1,
"department_name": "998",
"modified_on": 1653989953778,
"name": "",
"nick_name": "测试111122",
"page_title": "测试流程",
"page_type": 3,
"state": 2 // 该条数据的状态 0 正常/暂存中 1.完成 2. 处理中 3.拒绝
},
"field_info": { //数据体 key:value, key是控件的key,value是值
"00530aef-5745-49a6-853e-4b545e1ca8db": "{\"label\":\"123123\",\"value\":\"123123\",\"data_code\":\"4d664962-bde4-4066-b4c0-ccb642e181e0\"}",
"0bd6320d-e7df-4785-9255-3b82d7a6ab5f": [ //子表的值
{
"961f891a-a6b0-4e28-98b0-b68984b7b2f4": "1111",
"sub_data_key": "125f18db-685d-4672-a8c9-3f73ff0fe933"
},
{
"961f891a-a6b0-4e28-98b0-b68984b7b2f4": "2222",
"sub_data_key": "efb17359-b647-43c0-9bb1-e70d5a5e84c6"
},
{
"961f891a-a6b0-4e28-98b0-b68984b7b2f4": "3333",
"sub_data_key": "f3487184-15b8-4a7b-9154-795d773f5881"
}
],
"220f2fc1-ce19-4171-b5cf-860cc969ed46": "1232",
"c9185187-bcb7-4770-93f7-56f96a7ee266": "1232022-05-1800002"
}
}
某个表单的所有数据列表
- URL:page/alldatalist
- Method:
POST请求参数
| 参数 | 类型 | 描述 | | —- | —- | —- | | page_code | string | 表单的code | | page_size | int | 单页数量 | | page_index | int | 第几页 |
请求示例
可以仅传递部分请求参数。
{
"page_size": 10,
"page_index": 1,
"page_code": "17061fad-cb0b-429f-9927-0fec0a57f156"
}
成功响应
条件:请求参数合法,并且用户身份校验通过。
状态码:200 OK
响应示例:
{
"code": 0,
"msg": "ok",
"data": {
"count": 2, //数据条数
"info": [ //数据列表 key:value key是控件的key,value是值
{
"0de863a9-e518-4db5-b221-65132a357608": "{\"label\":\"选项2\",\"value\":\"选项2\"}",
"12e6aa17-d026-400c-b2e2-a227e6320f98": null,
"47f0f5e2-3696-446e-b842-0a32ed8e77ea": "222",
"72411576-411b-4199-9e0d-e6185ce3e35a": null,
"767a6f50-c587-4327-b6bb-91013daa3375": "2222",
"977d1d4c-558a-4d22-8653-4ac73174eef9": null,
"b4fa6d70-9d6e-4a8b-a9cb-588885227630": null,
"cd0da1a0-746d-4b79-b0e1-18456f13325d": null,
"corpid": "374f5167-53fd-41e4-bab2-a2625189e107",
"create_by": "111111",
"created_on": "1652938444517",
"d9d48de2-9194-41f8-b3fc-f64cda81c05d": null,
"data_code": "2f29e645-bd50-4a98-a0e0-345d0521d2ca",
"depart_id": "-1",
"ee5ea6b7-a95e-447b-971b-f2fd580b66bd": null,
"modified_on": "1652938444517",
"name": "",
"nick_name": "lyt", //创建人姓名
"page_code": "17061fad-cb0b-429f-9927-0fec0a57f156",
"state": "1"
},
{
"0de863a9-e518-4db5-b221-65132a357608": "{\"label\":\"选项1\",\"value\":\"选项1\"}",
"12e6aa17-d026-400c-b2e2-a227e6320f98": "222222",
"47f0f5e2-3696-446e-b842-0a32ed8e77ea": "111",
"72411576-411b-4199-9e0d-e6185ce3e35a": null,
"767a6f50-c587-4327-b6bb-91013daa3375": "11111",
"977d1d4c-558a-4d22-8653-4ac73174eef9": null,
"b4fa6d70-9d6e-4a8b-a9cb-588885227630": null,
"cd0da1a0-746d-4b79-b0e1-18456f13325d": null,
"corpid": "374f5167-53fd-41e4-bab2-a2625189e107",
"create_by": "111111",
"created_on": "1652938426486",
"d9d48de2-9194-41f8-b3fc-f64cda81c05d": "[{\"nick_name\":\"测试111122\",\"name\":\"\",\"userid\":\"202108309\"}]",
"data_code": "d70b733e-907f-411b-882f-a629204f11e8",
"depart_id": "-1",
"ee5ea6b7-a95e-447b-971b-f2fd580b66bd": null,
"modified_on": "1652938426486",
"name": "",
"nick_name": "lyt",
"page_code": "17061fad-cb0b-429f-9927-0fec0a57f156",
"state": "1"
}
]
}
}














