[关闭]
@lina 2020-11-24T10:34:04.000000Z 字数 23651 阅读 1111

新闪签云-后台接口

新闪签云


首页数据

请求URL

get
api/home

请求参数

  • date_type: [string] 统计图日期筛选 【day/month】

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "sealNum": 8,// 印章个数
  6. "sealUseNum": 111, // 印章使用量
  7. "contractNum": 26, // 合同模板数
  8. "contractUseNum": 111, // 合同模板使用量
  9. "saveCosts": 402,// 节约成本,
  10. "saveTime" : 111,// 节约时间
  11. "file_page_num": 745,// 文件张数
  12. "sendNum": [// 发送量
  13. {
  14. "time": "2020-10-19", // 日期 (
  15. date_type='day' -> "2020-10-19" ,
  16. date_type='month' -> "2020-10"
  17. "count": 0 // 个数
  18. }
  19. ],
  20. "successNum": [ // 成功量
  21. {
  22. "time": "2020-10-19", // 日期
  23. "count": 0 // 个数
  24. }
  25. ]
  26. }
  27. }

退出登录

请求URL

get
api/logout
响应

  1. {
  2. "status": 0,
  3. "msg": "退出成功",
  4. "data": null
  5. }

文字域

添加甲方文字域

请求URL

post
api/text_field

请求参数

  • vname: [string] 文字域key
  • label: [string] 文字域名称
  • type: [int] 文字域类型
  • options: [string] select 参数
  • listen_id: [int] selecty 1级id
  • category: [int] 类型

响应

  1. {
  2. "status": 0,
  3. "msg": "创建文字域成功",
  4. "data": null
  5. }

编辑甲方文字域

请求URL

put
api/text_field/{id}
注: id是要修改的文字域id

请求参数

  • vname: [string] 文字域key
  • label: [string] 文字域名称
  • type: [int] 文字域类型
  • options: [string] select 参数
  • listen_id: [int] selecty 1级id
  • id: [int] id是要修改的文字域id
  • category: [int] 类型

响应

  1. {
  2. "status": 0,
  3. "msg": "修改文字域成功",
  4. "data": null
  5. }

批量修改文字域状态

请求URL

post
api/text_field/changeStatus

请求参数

  • ids: [string] 以逗号分隔的id集合
  • status: [int] 禁用状态 0禁用 1启用

响应

  1. {
  2. "status": 0,
  3. "msg": "启用成功/禁用成功",
  4. "data": null
  5. }

列表(没有筛选条件)

请求URL

get
api/text_field

请求参数

  • keyword: [string] 文字域名称/文字域key
  • status: [int] 文字域禁用状态 0禁用 1启用
  • category: [int] 类型

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": [
  5. {
  6. "id": 92,
  7. "category": 2,
  8. "label": "姓名",
  9. "vname": "name",
  10. "type": 5,
  11. "rule": "",
  12. "options": "",
  13. "sort": 0,
  14. "listen_id": 0,
  15. "status": 1,
  16. "created_at": "2020-09-26 22:09:44",
  17. "updated_at": "2020-09-26 22:09:44"
  18. }
  19. ]
  20. }

公共

上传文件

请求URL

post
api/upload

请求参数

  • file: [file] 文件

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "url": "/uploads/875331600849167.jpg",
  6. "filename": "55597435bb036.jpg",
  7. "value": "/uploads/875331600849167.jpg"
  8. }
  9. }

后台账号

管理员修改自己的密码

请求URL

post
api/updatePwd

请求参数

  • old_password: [string] 旧密码
  • password: [string] 新密码
  • password_confirmation: [string] 新密码确认

响应

  1. {
  2. "status": 0,
  3. "msg": "修改密码成功",
  4. "data": null
  5. }

修改账号信息

请求URL

put
api/admin_user

请求参数

  • id: [int] 账号id
  • name: [string] 名称
  • username: [string] 账号
  • password: [string] 密码
  • status: [int] 禁用状态

响应

  1. {
  2. "status": 0,
  3. "msg": "修改账号成功",
  4. "data": null
  5. }

公司

公司选择器

请求URL

get
api/company_group_selector

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": [
  5. {
  6. "name": "guangying1",
  7. "id": 13
  8. }
  9. ]
  10. }

公司列表

请求URL

get
api/company_group

请求参数

  • name: [string] 公司名称
  • pageSize: [int] 每页条数
  • page: [int] 页码

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "list": [
  6. {
  7. "id": 1, // 公司id
  8. "name": "上海龙艺企业管理服务有限责任公司",// 公司名称
  9. "created_at": "2019-10-17 14:30:07",
  10. "updated_at": "2019-11-08 09:08:20",
  11. "company": [
  12. "name" : "xxx", // 主体名称
  13. "count" : 1, // 主体个数
  14. ],// 公司主体
  15. "department": [
  16. "name" : "xxx", // 部门名称
  17. "count" : 1, // 部门个数
  18. ], //
  19. "contract": {
  20. "master": 0, // 主合同
  21. "child": 0 // 子合同
  22. },
  23. "employee": 0, // 用户个数
  24. "to_be_signed": 0, // 待签署合同个数
  25. "signed": 0, // 已签署合同个数
  26. "unsigned": 0 // 取消签署合同个数
  27. }
  28. ],
  29. "total": 12 // 总条数
  30. }
  31. }

创建公司

请求URL

post
api/company_group

请求参数

  • name: [string] 公司名称
  • admin_name: [string] 负责人名称
  • username: [string] 账号
  • password: [string] 密码
  • status: [int] 禁用状态 0禁用 1启用
  • logo_url: [string] logo链接

响应

  1. {
  2. "status": 0,
  3. "msg": "创建企业成功",
  4. "data": null
  5. }

公司详细信息

请求URL

get
api/company_group/{id}

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "id": 12, // 公司id
  6. "name": "guangying",//公司名称
  7. "created_at": "2020-09-22 12:31:11",
  8. "updated_at": "2020-09-22 12:31:11",
  9. "admin_user": {
  10. "id": 12, // 负责人id
  11. "username": "123456", // 用户名
  12. "name": "lina",// 负责人名称
  13. "status": 1,// 状态
  14. }
  15. }
  16. }

修改公司详细信息

请求URL

put
api/company_group/{id}

请求参数

  • id: [int] 公司id
  • name: [string] 公司名称
  • status: [int] 禁用状态 0禁用 1启用
  • logo_url: [string] logo链接

响应

  1. {
  2. "status": 0,
  3. "msg": "修改企业账号成功",
  4. "data": null
  5. }

部门

部门选择器

请求URL

get
api/department_selector

请求参数

  • company_group_id: [int] 公司名称

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": [
  5. {
  6. "name": "测试部门2",
  7. "id": 18
  8. }
  9. ]
  10. }

创建部门

请求URL

post
api/department

请求参数

  • name: [string] 部门名称
  • admin_name: [string] 负责人名称
  • username: [string] 账号
  • password: [string] 密码
  • status: [int] 禁用状态 0禁用 1启用
  • company_group_id: [int] 公司id

响应

  1. {
  2. "status": 0,
  3. "msg": "创建部门成功",
  4. "data": null
  5. }

部门详细信息

请求URL

get
api/department/{id}

注释 : id就是部门id
如: api/department/1

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "id": 11, // 部门id
  6. "company_group_id": 12, //公司id
  7. "name": "测试部门", // 部门名称
  8. "invite_code": 62959, //邀请码
  9. "status": 1, // 禁用状态
  10. "created_at": "2020-09-22 18:02:11",
  11. "updated_at": "2020-09-22 18:02:11",
  12. "admin_user": {
  13. "id": 16,
  14. "name": "demo111", // 负责人名字
  15. "username": "de111", // 账号
  16. "status": 1, // 状态
  17. "relation_id": 11
  18. }
  19. }
  20. }

修改部门详细信息

请求URL

put
api/department/{id}

请求参数

  • id: [int] 部门id
  • name: [string] 部门名称
  • status: [int] 禁用状态 0禁用 1启用

响应

  1. {
  2. "status": 0,
  3. "msg": "修改部门成功",
  4. "data": null
  5. }

部门列表

请求URL

get
api/department

请求参数

  • perPage: [int] 每页条数
  • page: [int] 页码

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "list": [
  6. {
  7. "id": 11, // 部门id
  8. "name": "测试部门", // 部门名称
  9. "status": 1, // 禁用状态
  10. "admin_user": {
  11. "name": "demo111", // 负责人
  12. "username": "de111", // 账号
  13. "status": 1,
  14. "relation_id": 11
  15. }
  16. }
  17. ],
  18. "total": 12 // 总条数
  19. }
  20. }

主体

删除主体

请求URL

delete
api/company/{id}
注 : id = 是主体id

响应

  1. {
  2. "status": 0,
  3. "msg": "删除成功",
  4. "data": null
  5. }

重新认证主体

请求URL

post
api/company/{id}/recertification
注 : id = 是主体id

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "url": "https://smlfront.esign.cn:8890/identity/login?param=8t%2Fev%2BDvBSYpAqGdcGow1EFxToqJbOLP9zSJUNcz43vbknTk9gGRp%2BnWkyUN7QeKxiVtuTgGL3v1KDk2mhapS78rH3XYMcUqePSZbfDETSCwVsa9M2LaXC8iKKgVzUFxzrR9KyhpeD3ajk5evPqEO0RZT1UbfjGtPWxqDiViTBXm4PB2JSPnz2FvSSmI9YPclgjtZQ4yFj8o1OLHhH1BCS3ql2gQJZmE3ziD25nRJUJaj8ZNR6QwgDbczrLAgALCN4jXpQ9EYpMVhASypvm%2BiqIMV1zdZBpI0bJhBH7t0B9k894HQLuXuYNBEMO9U8m2uWsK9qrOXXhQfn8SHMW32AODMKDuBZ2l27JVtTyzvmk%3D&lang=zh-CN"
  6. }
  7. }

主体选择器

请求URL

get
api/company_selector

请求参数

  • company_group_id: [int] 公司名称

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": [
  5. {
  6. "name": "江西龙艺人力资源服务有限公司深圳分公司",
  7. "id": 12
  8. }
  9. ]
  10. }

创建主体

请求URL

post
api/company

请求参数

  • company_group_id: [int] 公司id
  • name: [string] 主体名称
  • phone: [string] 公司手机号
  • license: [string] 营业编号
  • juridical_name: [string] 法人名字
  • juridical_idno: [sting] 法人身份证号
  • email: [string] 公司邮件
  • addr: [string] 公司地址
  • relation_em_id: [int] 认证人id
  • status: [int] 禁用状态
  • id_type: [string] 主体类型

响应

  1. {
  2. "status": 0,
  3. "msg": "创建主体成功",
  4. "data": null
  5. }

主体详细信息

请求URL

get
api/company/{id}

注释 : id就是主体id
如: api/company/1

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "id": 1,
  6. "company_group_id": 0,// 公司id
  7. "name": "上海龙艺企业管理服务有限责任公司", //主体名
  8. "license": "上海;江西吉安;浙江宁波;浙江杭州;浙江海宁;厦门;广东深圳",//营业执照
  9. "juridical_name": "",//法人名
  10. "juridical_idno": "",// 法人身份证号
  11. "addr": "", // 公司地址
  12. "relation_em_id": 0,// 认证人名
  13. "verify_url": "", // e签宝返回认证url
  14. "status": 0, // 禁用状态
  15. "created_at": "2019-10-17 14:30:07",
  16. "updated_at": "2019-11-08 09:08:20"
  17. }
  18. }

主体列表

请求URL

get
api/company

请求参数

  • perPage: [int] 每页条数
  • page: [int] 页码
  • name: [string] 主体名称
  • status: [int] 禁用状态

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "list": [
  6. {
  7. "id": 1,
  8. "company_group_id": 0,// 公司id
  9. "name": "上海龙艺企业管理服务有限责任公司", //主体名
  10. "license": "上海;江西吉安;浙江宁波;浙江杭州;浙江海宁;厦门;广东深圳",//营业执照
  11. "juridical_name": "",//法人名
  12. "juridical_idno": "",// 法人身份证号
  13. "addr": "", // 公司地址
  14. "relation_em_id": 0,// 认证人名
  15. "verify_url": "", // e签宝返回认证url
  16. "status": 0, // 禁用状态
  17. "created_at": "2019-10-17 14:30:07",
  18. "updated_at": "2019-11-08 09:08:20"
  19. }
  20. ],
  21. "total": 12 // 总条数
  22. }
  23. }

合同

合同名称判断是否唯一

请求URL

get
api/contract/checkName

请求参数

  • name: [string] 合同名称

正确响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "status" : 1
  6. }
  7. }

错误响应

  1. {
  2. "status": 1000,
  3. "msg": "合同名称已被使用",
  4. "data": {
  5. "status": 0
  6. }
  7. }

合同列表

请求URL

get
api/contract

请求参数

  • pageSize: [int] 每页条数
  • page: [int] 页码
  • name: [string] 合同名称
  • company_id: [int] 签约主体
  • type: [int] 合同类型 1主 2附属
  • status: [int] 禁用状态
  • company_group_id: [int] 公司id

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "list": [
  6. {
  7. "id": 41,
  8. "company_group_id": 13, // 公司id
  9. "company_id": 13, // 主体id
  10. "type": 1,// 合同类型 1 主 2 附属
  11. "sub_type": 0,// 附属协议子类型 1 修改 2终止
  12. "name": "测试合同",// 合同名
  13. "contract_info_id": 0, // 版本号
  14. "created_at": "2020-09-24 18:56:50",
  15. "updated_at": "2020-09-24 18:56:50",
  16. "contract_company": [
  17. {
  18. "id": 67,
  19. "company_group_id": 11,
  20. "name": "上海浦东龙艺企业管理服务有限公司",
  21. "email": "wenqiqi@shlongyi.cn",
  22. "phone": "4008269296",
  23. "license": "91310115MA1HAAQM1L",
  24. "juridical_name": "杨彩红",
  25. "juridical_idno": "310104197109164048",
  26. "addr": "江西省吉安市永丰县恩江镇龙冈北路",
  27. "relation_em_id": "60ac70906b844a04a4a8b8344daa33c4",
  28. "verify_url": "https://smlfront.esign.cn:8890/identity/login?param=Cv0lWcuqeuKx1tJKejcujQxYX88dIoHu0nYPPNeU%2Fo7ef3xRhtV2vU3Hr7UZ8ea%2B%2F3oUwY4MW9UxVlyYA4fnX2ivbl4Ve1BjJ5WSBSm0ZAaqLP%2Bj9Y9SHgYUtoTsBRa88zRVnCNXJNWnSYiiN3cdiWaLmEn5hBJWl1IGinAVtmEGyoCXJ6iNmg3dEaNWh8S9LdO7JVM9siCrfEBzUICKPVrgoSDjXqt7BBkNUhPFVJQtfoKMU8fnSRIdGieBYmpWBim4MJN1dvSnAo5wMe5BfSmB9h5iduO1xWpcHbT40IqXxd8zy%2Bk69n8fVbQuo9SZKtDKjpj8XizL13sx38scUXJJRiIY3JH41gNj%2BaG40xk%3D&lang=zh-CN",
  29. "e_sign_seal_id": "cce117b8-dfd7-470a-b04f-83dabfa72141",
  30. "e_sign_acct_id": "0102ca1e5db140118eaa858400ee317e",
  31. "status": 1,
  32. "flowId": "1492230401761001172",
  33. "verify_code": "6aecb69a82f2ef387890bba1c6910bee",
  34. "id_type": "CRED_ORG_USCC",
  35. "created_at": "2020-11-17 18:28:06",
  36. "updated_at": "2020-11-23 17:17:29",
  37. "pivot": {
  38. "contract_id": 68,
  39. "company_id": 67
  40. }
  41. }
  42. ],
  43. "department": [],
  44. "contract_info": null,
  45. "to_be_signed": 0,
  46. "signed": 0,
  47. "unsigned": 0
  48. }
  49. ],
  50. "total": 12 // 总条数
  51. }
  52. }

合同详细信息

请求URL

get
api/contract/{id}

注释 : id就是合同id
如: api/contract/1

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "id": 5,
  6. "company_group_id": 12,
  7. "company_id": 12,
  8. "type": 1,
  9. "sub_type": 0,
  10. "name": "测试上传合同20200929B3",
  11. "status": 1,
  12. "contract_info_id": 7,
  13. "created_at": "2020-09-29 20:28:36",
  14. "updated_at": "2020-10-03 17:45:43",
  15. "contract_info": {
  16. "id": 6,
  17. "contract_id": 5,
  18. "template_id": "4b56ddb0e4834887a3f8417df50649fc",
  19. "file_url": "/upload/contract/771971601382504.pdf",
  20. "contract_text_field": [
  21. {
  22. "label": "signed_date",
  23. "limit": null,
  24. "required": false,
  25. "style": {
  26. "font": null,
  27. "fontSize": null,
  28. "textColor": null,
  29. "width": 152.457,
  30. "height": 15.095001,
  31. "bold": false
  32. },
  33. "pos": {
  34. "x": 100.455,
  35. "y": 456.366,
  36. "page": 13
  37. },
  38. "options": null,
  39. "version": 1,
  40. "ext": null
  41. },
  42. ...
  43. ],
  44. "text_field_conf": {//文字域配置
  45. "1": 1,
  46. "2": 1,
  47. "5": 0,
  48. "7": 0,
  49. "16": 1,
  50. "18": 1,
  51. "20": 1
  52. },
  53. "remarks": "初始版本",
  54. "status": 1,
  55. "created_at": "2020-09-29 20:28:36",
  56. "updated_at": "2020-09-30 15:41:19"
  57. },
  58. "company_group": {//集团信息
  59. "id": 12,
  60. "name": "_guangying_",
  61. "logo_url": "/upload/733501601389789.jpg",
  62. "status": 1,
  63. "created_at": "2020-09-22 12:31:11",
  64. "updated_at": "2020-09-29 22:29:51"
  65. },
  66. "contract_company": [
  67. {
  68. "id": 67,
  69. "company_group_id": 11,
  70. "name": "上海浦东龙艺企业管理服务有限公司",
  71. "email": "wenqiqi@shlongyi.cn",
  72. "phone": "4008269296",
  73. "license": "91310115MA1HAAQM1L",
  74. "juridical_name": "杨彩红",
  75. "juridical_idno": "310104197109164048",
  76. "addr": "江西省吉安市永丰县恩江镇龙冈北路",
  77. "relation_em_id": "60ac70906b844a04a4a8b8344daa33c4",
  78. "verify_url": "https://smlfront.esign.cn:8890/identity/login?param=Cv0lWcuqeuKx1tJKejcujQxYX88dIoHu0nYPPNeU%2Fo7ef3xRhtV2vU3Hr7UZ8ea%2B%2F3oUwY4MW9UxVlyYA4fnX2ivbl4Ve1BjJ5WSBSm0ZAaqLP%2Bj9Y9SHgYUtoTsBRa88zRVnCNXJNWnSYiiN3cdiWaLmEn5hBJWl1IGinAVtmEGyoCXJ6iNmg3dEaNWh8S9LdO7JVM9siCrfEBzUICKPVrgoSDjXqt7BBkNUhPFVJQtfoKMU8fnSRIdGieBYmpWBim4MJN1dvSnAo5wMe5BfSmB9h5iduO1xWpcHbT40IqXxd8zy%2Bk69n8fVbQuo9SZKtDKjpj8XizL13sx38scUXJJRiIY3JH41gNj%2BaG40xk%3D&lang=zh-CN",
  79. "e_sign_seal_id": "cce117b8-dfd7-470a-b04f-83dabfa72141",
  80. "e_sign_acct_id": "0102ca1e5db140118eaa858400ee317e",
  81. "status": 1,
  82. "flowId": "1492230401761001172",
  83. "verify_code": "6aecb69a82f2ef387890bba1c6910bee",
  84. "id_type": "CRED_ORG_USCC",
  85. "created_at": "2020-11-17 18:28:06",
  86. "updated_at": "2020-11-23 17:17:29",
  87. "pivot": {
  88. "contract_id": 68,
  89. "company_id": 67
  90. }
  91. }
  92. ],
  93. "text_field_conf": [//乙方文字域配置
  94. {
  95. "id": 1,
  96. "category": 2,
  97. "label": "姓名",
  98. "vname": "real_name",
  99. "type": 5,
  100. "rule": "",
  101. "options": "",
  102. "sort": 0,
  103. "listen_id": 0,
  104. "status": 1,
  105. "created_at": "2020-09-28 19:32:42",
  106. "updated_at": "2020-09-28 20:56:47",
  107. "required": 1
  108. },
  109. ...
  110. ],
  111. "party_a_text_field_conf": [//甲方文字域配置
  112. {
  113. "id": 20,
  114. "category": 1,
  115. "label": "岗位",
  116. "vname": "work_pos",
  117. "type": 1,
  118. "rule": "",
  119. "options": "",
  120. "sort": 0,
  121. "listen_id": 0,
  122. "status": 1,
  123. "created_at": "2020-09-28 19:37:40",
  124. "updated_at": "2020-09-28 21:03:30"
  125. },
  126. ...
  127. ]
  128. }
  129. }

创建合同

请求URL

post
api/contract

请求参数

  • company_id: [int] 主体id
  • company_ids: [string] 主体id (以逗号分隔)
  • name: [string] 合同名称
  • file_url: [string] 合同链接
  • template_id: [string] e签宝模板id
  • text_field_conf: [json] 选择的文字域
  • type: [int] 合同类型 1主 2附属
  • sub_type: [int] 附属协议的子类型 1 修改 2 终止(type=2时必传)
  • company_group_id: [int] 公司id (注:admin需要传)
  • edu_show: [int] 学历信息是否显示 (注:0不显示 1显示)
  • work_show: [int] 工作信息是否显示 (注:0不显示 1显示)
  • edu_require: [int] 学历信息是否必传 (注:0不必传 1必传)
  • work_require: [int] 工作信息是否必传 (注:0不必传 1必传)

响应

  1. {
  2. "status": 0,
  3. "msg": "创建合同成功",
  4. "data": {id:1}
  5. }

修改合同详细信息

请求URL

put
api/contract

请求参数

  • id: [int] 合同id
  • file_url: [string] 合同链接
  • template_id: [string] e签宝模板id
  • text_field_conf: [json] 选择的文字域
  • remarks: [string] 备注
  • edu_show: [int] 学历信息是否显示 (注:0不显示 1显示)
  • work_show: [int] 工作信息是否显示 (注:0不显示 1显示)
  • edu_require: [int] 学历信息是否必传 (注:0不必传 1必传)
  • work_require: [int] 工作信息是否必传 (注:0不必传 1必传)
  • company_ids: [string] 主体id (以逗号分隔)

响应

  1. {
  2. "status": 0,
  3. "msg": "修改合同成功",
  4. "data": null
  5. }

合同关联部门 (分配部门)

请求URL

post
api/contract/allotDepartment

请求参数

  • id: [int] 合同id
  • department_ids: [string] 部门id集合 (注:以逗号分隔)

响应

  1. {
  2. "status": 0,
  3. "msg": "分配部门成功",
  4. "data": null
  5. }

合同版本列表

请求URL

get
api/contract/{id}/version
注: id 为合同id

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": [
  5. {
  6. "id": 1,// 版本id
  7. "remarks": "", // 备注
  8. "status": 1, // 禁用状态
  9. "contract_id": 1, // 合同id
  10. "template_id": "dff56cb656ef40769e7b6a1dc5306889",// 模板id
  11. "file_url": "/upload/contract/572161601299387.pdf",//文件路径
  12. "text_field_conf": "",
  13. "created_at": "2020-09-28 21:35:58",
  14. "updated_at": "2020-09-29 18:51:08"
  15. }
  16. ]
  17. }

合同禁用

请求URL

put
api/contract/{id}/disable

请求参数

  • id: [int] 合同id

响应

  1. {
  2. "status": 0,
  3. "msg": "合同禁用成功",
  4. "data": null
  5. }

合同selector

仅展示状态上线的合同,admin取所有,公司取公司的,部门取已分配的合同
请求URL

get
api/contract/selector

请求参数

  • keyword: [string] 搜索关键词
  • type: [int] 合同类型,默认1
  • sub_type: [int] 协议类型 默认0
  • status: [int] 协议状态 1在线 0禁用 不传或为空时

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": [
  5. {
  6. "id": 5,
  7. "name": "测试上传合同20200929B3"
  8. }
  9. ]
  10. }

员工

员工列表(admin)

请求URL

get
api/employee/adminAuthority

请求参数

  • pageSize: [int] 每页条数
  • page: [int] 页码
  • keyword: [string] 名称/手机号/身份证
  • company_group_id: [int] 公司id
  • department_id: [int] 部门id
  • export: [int] 1导出 其他忽略

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "list": [
  6. {
  7. "id": 92,
  8. "real_name": "测试", // 用户名
  9. "phone": "166210819913", // 手机号
  10. "id_number": "372922199611169010",// 身份证号
  11. "gender": 1, // 性别
  12. "es_id": 1, // e签宝实名表的主键id,实名流水id
  13. "es_acct_id": "1", // e签宝的adccount id
  14. "verify_status": 1,// 0 待实名, 1实名中,2实名成功 3实名失败
  15. "created_at": "2020-09-29 17:44:11",
  16. "updated_at": "2020-09-29 17:44:11",
  17. "department": {
  18. "12": {
  19. "id": 12,// 公司id
  20. "name": "_guangying_", // 公司名
  21. "logo_url": "/upload/733501601389789.jpg", // logo
  22. "status": 1, // 禁用状态
  23. "created_at": "2020-09-22 12:31:11",
  24. "updated_at": "2020-09-29 22:29:51",
  25. "department": [
  26. {
  27. "id": 18,// 部门id
  28. "company_group_id": 12,
  29. "name": "测试部门2",// 部门名称
  30. "invite_code": 28063, // 邀请码
  31. "status": 1,// 禁用状态
  32. "created_at": "2020-09-22 19:24:17",
  33. "updated_at": "2020-09-22 19:24:17",
  34. "in_out_id": 11
  35. },
  36. ]
  37. }
  38. },
  39. "record": { // 调用记录
  40. "12": [
  41. {
  42. "id": 22,
  43. "company_group_id": 12, // 公司id
  44. "name": "测试部门7", // 部门名称
  45. "invite_code": 38808,
  46. "status": 1,
  47. "created_at": "2020-09-29 17:48:36",
  48. "updated_at": "2020-09-29 17:48:36",
  49. "in_out_id": 19,
  50. "past_life": {
  51. "id": 12,
  52. "company_group_id": 13,// 公司id
  53. "name": "测试部门1",// 部门名称
  54. "invite_code": 74668,
  55. "status": 1,
  56. "created_at": "2020-09-22 18:10:48",
  57. "updated_at": "2020-09-24 19:16:55"
  58. }
  59. }
  60. ]
  61. },
  62. "to_be_signed": 0, // 待签署
  63. "signed": 0 // 已签署
  64. }
  65. ],
  66. "total": 1
  67. }
  68. }

员工列表(compnayGroup)

请求URL

get
api/employee/companyGroupAuthority

请求参数

  • pageSize: [int] 每页条数
  • page: [int] 页码
  • keyword: [string] 名称/手机号/身份证
  • department_id: [int] 部门id

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "list": [
  6. {
  7. "id": 92,
  8. "real_name": "测试", // 用户名
  9. "phone": "166210819913", // 手机号
  10. "id_number": "372922199611169010",// 身份证号
  11. "gender": 1, // 性别
  12. "es_id": 1, // e签宝实名表的主键id,实名流水id
  13. "es_acct_id": "1", // e签宝的adccount id
  14. "verify_status": 1,// 0 待实名, 1实名中,2实名成功 3实名失败
  15. "created_at": "2020-09-29 17:44:11",
  16. "updated_at": "2020-09-29 17:44:11",
  17. "department": {
  18. "12": {
  19. "id": 12,// 公司id
  20. "name": "_guangying_", // 公司名
  21. "logo_url": "/upload/733501601389789.jpg", // logo
  22. "status": 1, // 禁用状态
  23. "created_at": "2020-09-22 12:31:11",
  24. "updated_at": "2020-09-29 22:29:51",
  25. "department": [
  26. {
  27. "id": 18,// 部门id
  28. "company_group_id": 12,
  29. "name": "测试部门2",// 部门名称
  30. "invite_code": 28063, // 邀请码
  31. "status": 1,// 禁用状态
  32. "created_at": "2020-09-22 19:24:17",
  33. "updated_at": "2020-09-22 19:24:17",
  34. "in_out_id": 11
  35. },
  36. ]
  37. }
  38. },
  39. "record": { // 调用记录
  40. "12": [
  41. {
  42. "id": 22,
  43. "company_group_id": 12, // 公司id
  44. "name": "测试部门7", // 部门名称
  45. "invite_code": 38808,
  46. "status": 1,
  47. "created_at": "2020-09-29 17:48:36",
  48. "updated_at": "2020-09-29 17:48:36",
  49. "in_out_id": 19,
  50. "past_life": {
  51. "id": 12,
  52. "company_group_id": 13,// 公司id
  53. "name": "测试部门1",// 部门名称
  54. "invite_code": 74668,
  55. "status": 1,
  56. "created_at": "2020-09-22 18:10:48",
  57. "updated_at": "2020-09-24 19:16:55"
  58. }
  59. }
  60. ]
  61. },
  62. "to_be_signed": 0, // 待签署
  63. "signed": 0 // 已签署
  64. }
  65. ],
  66. "total": 1
  67. }
  68. }

员工列表(department)

请求URL

get
api/employee/departmentAuthority

请求参数

  • pageSize: [int] 每页条数
  • page: [int] 页码
  • keyword: [string] 名称/手机号/身份证
  • status: [int] 转入转出状态 1转入 2转出

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "list": [
  6. {
  7. "id": 92,
  8. "real_name": "测试",// 员工名
  9. "phone": "166210819913",// 手机号
  10. "id_number": "372922199611169010",// 身份证号
  11. "gender": 1,//性别
  12. "es_id": 1,
  13. "es_acct_id": "1",
  14. "verify_status": 1,// 0 待实名, 1实名中,2实名成功 3实名失败
  15. "created_at": "2020-09-29 17:44:11",
  16. "updated_at": "2020-09-29 17:44:11",
  17. "department": {
  18. "id": 22,
  19. "company_group_id": 12,
  20. "name": "测试部门7",// 部门名
  21. "invite_code": 38808,// 邀请码
  22. "status": 1,
  23. "created_at": "2020-09-29 17:48:36",
  24. "updated_at": "2020-09-29 17:48:36"
  25. },
  26. "company_group": {
  27. "id": 12,
  28. "name": "_guangying_",//公司名
  29. "logo_url": "/upload/733501601389789.jpg", // logo
  30. "status": 1,
  31. "created_at": "2020-09-22 12:31:11",
  32. "updated_at": "2020-09-29 22:29:51"
  33. },
  34. "in_out_id": 19,
  35. "in_time": "2020-09-29 21:26:18",// 转入时间
  36. "out_time": "2020-09-29 21:26:18", // 转出时间
  37. "type": 1,// 1转入 2转出 0新加入
  38. "to_be_signed": 0,
  39. "signed": 0
  40. }
  41. ],
  42. "total": 1
  43. }
  44. }

员工搜索(加入员工场景)

请求URL

get
api/employee/search

请求参数

  • keyword: [string] 手机号/身份证

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "id": 96,
  6. "real_name": "员工5",
  7. "phone": "16621980482",
  8. "id_number": "372922199328548",
  9. "gender": 1,
  10. "es_id": 1,
  11. "es_acct_id": "1",
  12. "verify_status": 2,
  13. "created_at": "2020-09-30 20:05:51",
  14. "updated_at": "2020-10-04 15:56:36",
  15. "in_department": false//是否已在当前部门
  16. }
  17. }

将员工加入部门

请求URL

post
api/employee/storeInternal

请求参数

  • id: [string] 员工id,多个逗号分隔

响应

  1. {
  2. "status": 0,
  3. "msg": "加入成功",
  4. "data": {
  5. }
  6. }

员工转出

请求URL

post
api/employee/out

请求参数

  • id: [string] 员工id,多个逗号分隔
  • department_id: [int] 转入的部门id

响应

  1. {
  2. "status": 0,
  3. "msg": "转出成功",
  4. "data": {
  5. }
  6. }

员工selector

仅展示审核通过的合同,admin取所有,公司取公司的,部门取部门的
请求URL

get
api/employee/selector

请求参数

  • keyword: [string] 搜索关键词

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": [
  5. {
  6. "id": 92,
  7. "real_name": "员工1",
  8. "phone": "166210819913",
  9. "id_number": "372922199611169010",
  10. "gender": 1,
  11. "es_id": 1,
  12. "es_acct_id": "1",
  13. "verify_status": 2,
  14. "created_at": "2020-09-29 17:44:11",
  15. "updated_at": "2020-10-04 15:56:31"
  16. }
  17. ]
  18. }

员工信息

请求URL

get
api/employee/{id}

请求参数

  • id: [int] 员工id

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "id": 122,
  6. "real_name": "武帅冲",
  7. "phone": "14412341234",
  8. "id_number": "372922199611169010",
  9. "gender": 0, //性别 0未知 1男 2女
  10. "es_id": 11,
  11. "es_acct_id": "ebc6f9aa67ac4fd7b08d6efa8bbfb002",
  12. "verify_status": 2,
  13. "created_at": "2020-10-12 19:01:37",
  14. "updated_at": "2020-10-13 00:17:04",
  15. "age": 23,
  16. "edu": [// 教育经历
  17. ],
  18. "work": [ //工作经历
  19. ],
  20. "text_field": [ // 乙方已填写文字域
  21. {
  22. "id": 123,
  23. "em_id": 122,
  24. "text_field_id": 5,
  25. "vname": "party_b_nation",
  26. "val": "回族",
  27. "created_at": "2020-10-13 00:26:24",
  28. "updated_at": "2020-10-13 00:27:56"
  29. },
  30. {
  31. "id": 124,
  32. "em_id": 122,
  33. "text_field_id": 180,
  34. "vname": "party_b_marita_status",
  35. "val": "未婚",
  36. "created_at": "2020-10-13 00:27:56",
  37. "updated_at": "2020-10-13 00:27:56"
  38. }
  39. ],
  40. "employee_text_filed": [
  41. ]// 文字域全量类容
  42. }
  43. }

员工修改

请求URL

post
api/employee/{id}

请求参数

  • id: [int] 员工id
  • phone: [string] 手机号
  • text_field[*]: [mixed] 文字域相关字段
  • edu_exp: [array] 员工id
  • work_exp: [array] 员工id

请求数据包示例:

  1. {
  2. "text_field": {
  3. "party_b_nation": "回族",
  4. "party_b_marita_status": "未婚"
  5. },
  6. "phone": "14412341234",
  7. "edu_exp": [
  8. {
  9. "em_id": 1,
  10. "school": "北京理工大学",
  11. "edu": "本科",
  12. "start_date": "2016-08-07",
  13. "end_date": "2019-08-29"
  14. }
  15. ],
  16. "work_exp": [
  17. {
  18. "company": "依图科技",
  19. "work_pos": "测试",
  20. "salary": "年薪300w",
  21. "departure_reason": "2019-09-29",
  22. "start_date": "2019-08-31",
  23. "end_date": "2019-08-31"
  24. },
  25. {
  26. "company": "test",
  27. "work_pos": "test",
  28. "salary": "2019-08-07",
  29. "departure_reason": "2019-08-29",
  30. "start_date": "2019-08-31",
  31. "end_date": "2019-08-31"
  32. }
  33. ]
  34. }

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. }
  6. }

签约

签约简单列表

请求URL

get
api/sign_simple
请求参数
* company_group_id: [int] 公司id
* department_id: [int] 主体id
* contract_id: [int] 主合同id
* company_id: [int] 主体id
* em_id: [int] 员工id
* type: [int] 是否是主合同 1 主 2 附属
* status: [int] 签约状态 1(待签约,驳回)2(审核中)3(完成)4(失败)5(签约中)

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "list": [
  6. {
  7. "id": 11,
  8. "em_id": 5,
  9. "admin_user_id": 38,
  10. "contract_id": 6,
  11. "contract_info_id": 7,
  12. "company_id": 21,
  13. "company_group_id": 2,
  14. "department_id": 4,
  15. "flow_id": 0,
  16. "es_sign_id": 15,
  17. "contract_serial": "",
  18. "start_time": "0000-00-00",
  19. "end_time": "0000-00-00",
  20. "send_time": "2020-10-21 14:58:47",
  21. "sign_time": null,
  22. "reject_time": null,
  23. "cancel_time": "2020-10-21 15:13:53",
  24. "success_time": null,
  25. "close_tips_time": null,
  26. "sort": 1603263527,
  27. "status": 5,
  28. "reason": null,
  29. "cancel_reason": "甲方撤销流程",
  30. "company_text": {},
  31. "employee_text": null,
  32. "ext": null,
  33. "created_at": "2020-10-21 14:58:47",
  34. "updated_at": "2020-10-21 15:13:53",
  35. "close_tips": false,
  36. "expire_day": -1,
  37. "company_text_format": {
  38. },
  39. "company": {
  40. "id": 21,
  41. "company_group_id": 2,
  42. "name": "光盈创新(北京)科技有限公司",
  43. "email": "1091345598@qq.com",
  44. "phone": "16621089913",
  45. "license": "91110101306667748E",
  46. "juridical_name": "刘丽",
  47. "juridical_idno": "35048119910924502X",
  48. "addr": "午灵",
  49. "relation_em_id": "c82917c37a7e4fa2ad7ec7320f1cba0a",
  50. "verify_url": "",
  51. "e_sign_seal_id": "2af03ce4-37f5-49db-87b0-38ac5cbdfa33",
  52. "e_sign_acct_id": "31e32d50d45c4f68b10ea885801f7cd1",
  53. "status": 1,
  54. "flowId": "1483578107062431698",
  55. "verify_code": "78a2f53b4997a7c1c1f342ea2be0478e",
  56. "created_at": "2020-10-20 11:22:26",
  57. "updated_at": "2020-10-20 11:24:39"
  58. },
  59. "employee": {
  60. "id": 5,
  61. "real_name": "罗奕淦",
  62. "phone": "17710210877",
  63. "id_number": "350481198910305011",
  64. "gender": 1,
  65. "es_id": 5,
  66. "es_acct_id": "29022ef89f9644e48ade8ee52fd1bce6",
  67. "verify_status": 2,
  68. "created_at": "2020-10-21 09:57:51",
  69. "updated_at": "2020-10-21 11:16:41",
  70. "age": 30
  71. },
  72. "contract": {
  73. "id": 6,
  74. "company_group_id": 2,
  75. "company_id": 21,
  76. "type": 1,
  77. "sub_type": 0,
  78. "name": "中路承包",
  79. "status": 1,
  80. "contract_info_id": 7,
  81. "created_at": "2020-10-20 15:34:30",
  82. "updated_at": "2020-10-20 15:34:30"
  83. },
  84. "contract_info": {
  85. "id": 7,
  86. "contract_id": 6,
  87. "template_id": "57bf6fa69c1d45a996e791bdd2e78f24",
  88. "file_url": "http://admin.qian.guangying.link/uploads/2020-10/contract//64929",
  89. "contract_text_field": [
  90. ],
  91. "text_field_conf": {
  92. },
  93. "remarks": "初始版本",
  94. "status": 1,
  95. "created_at": "2020-10-20 15:34:30",
  96. "updated_at": "2020-10-20 15:34:30"
  97. },
  98. "sons": [],
  99. "es_sign": {
  100. "id": 15,
  101. "flow_id": "429b32154d06474aa07c55ed999a214e",
  102. "acct_id": "29022ef89f9644e48ade8ee52fd1bce6",
  103. "body_acct_id": "31e32d50d45c4f68b10ea885801f7cd1",
  104. "body_seal_id": "2af03ce4-37f5-49db-87b0-38ac5cbdfa33",
  105. "contract_info_id": 0,
  106. "contract_id": 6,
  107. "template_id": "57bf6fa69c1d45a996e791bdd2e78f24",
  108. "form_field": null,
  109. "sign_status": 0,
  110. "sign_time": null,
  111. "short_url": null,
  112. "url": null,
  113. "error_info": null,
  114. "file_id": null,
  115. "file_name": null,
  116. "created_at": "2020-10-21 14:58:47",
  117. "updated_at": "2020-10-21 14:58:47"
  118. }
  119. }
  120. ],
  121. "total": 1
  122. }
  123. }

签约列表

请求URL

get
api/sign

请求参数

  • contract_id: [int] 主合同id
  • keyword: [string] 关键字
  • tab: [string] tab all所有 normal正常 due即将到期 overdue已过期
  • type: [int] 状态 1待签署 2待审核 3签署成功 4签署失败

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data":{
  5. "list":[
  6. {
  7. "id": 84,
  8. "em_id": 92,
  9. "admin_user_id": 16,
  10. "contract_id": 5,
  11. "contract_info_id": 7,
  12. "company_id": 13,
  13. "company_group_id": 13,
  14. "department_id": 11,
  15. "sign_flow_id": 0,
  16. "es_sign_id": 32, // 关联签约保的id,为0则表示没有送签
  17. "contract_serial": "",
  18. "start_time": "0000-00-00", //合同开始时间
  19. "end_time": "0000-00-00", //合同结束时间
  20. "send_time": "2020-10-05 11:14:24", //甲方发送合同时间
  21. "sign_time": null, // 乙方签署时间
  22. "reject_time": null, // 审核时间
  23. "cancel_time": null, // 取消时间
  24. "success_time": null, // 合同存档时间
  25. "close_tips": true,// 是否关闭了到期提醒
  26. "expire_day": 1,// >0 表示还有N天过期,30天内才会有此值 =0 还未过期,离过期大于30天 =-1 已过期
  27. "sort": 0,
  28. "status": 1,
  29. "reason": null,
  30. "company_text":{},//甲方文字域内容
  31. "company_text_format":{"salary":{"value":"300","label":"薪水"},"work_pos":{"value":"上海","label":"岗位"}},//甲方文字域格式化后内容
  32. "employee_text": null,//乙方文字域内容
  33. "ext":{},//
  34. "created_at": "2020-10-05 12:01:25",
  35. "updated_at": "2020-10-06 15:22:49",
  36. "company":{},//签署主体
  37. "employee":{},//员工信息
  38. "contract":{},//合同信息
  39. "contract_info":{},//合同版本版本信息
  40. "sons":[],//关联协议信息
  41. "es_sign":{},//关联的e签保信息
  42. }
  43. ],
  44. "total": 1
  45. }
  46. }

合同列表红点提示

请求URL

get
api/sign/tips

请求参数

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. "due_count": 0, //即将过期总数
  6. "overdue_count": 0//过期总数
  7. }
  8. }

发送合同

请求URL

post
api/sign

请求参数

  • contract_id: [int] 主合同id
  • em_id: [int] 员工id
  • start_time: [string] 合同开始时间 格式:2020-02-12
  • end_time: [string] 合同结束时间 格式:2020-02-12
  • text_field[*]: [mixed] 文字域相关字段
  • company_id: [int] 主体id

响应

  1. {
  2. "status": 0,
  3. "msg": "发送合同成功",
  4. "data": {
  5. }
  6. }

发送附属协议

请求URL

post
api/sign/agreement

请求参数

  • contract_id: [int] 主合同id
  • em_id: [int] 员工id
  • sign_flow_id: [int] 关联主合同id
  • text_field[*]: [mixed] 文字域相关字段

响应

  1. {
  2. "status": 0,
  3. "msg": "发送附属协议成功",
  4. "data": {
  5. }
  6. }

签约详情

此接口返回乙方文字域内容
请求URL

get
api/sign/{id}

请求参数

  • id: [int] 签约id

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. }
  6. }

关闭签约提醒

请求URL

post
api/sign/{id}/close/tips

请求参数

  • id: [int] 签约id

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. }
  6. }

签约取消

请求URL

post
api/sign/{id}/cancel

请求参数

  • id: [int] 签约id

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. }
  6. }

签约审核拒绝

请求URL

post
api/sign/{id}/reject

请求参数

  • id: [int] 签约id

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. }
  6. }

签约审核通过

请求URL

post
api/sign/{id}/pass

请求参数

  • id: [int] 签约id

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data": {
  5. }
  6. }

员工签约列表

请求URL

get
api/employee/{id}/sign

请求参数

  • id: [int] 员工id

响应

  1. {
  2. "status": 0,
  3. "msg": "",
  4. "data":{
  5. "list":[
  6. {
  7. "id": 84,
  8. "em_id": 92,
  9. "admin_user_id": 16,
  10. "contract_id": 5,
  11. "contract_info_id": 7,
  12. "company_id": 13,
  13. "company_group_id": 13,
  14. "department_id": 11,
  15. "sign_flow_id": 0,
  16. "es_sign_id": 32, // 关联签约保的id,为0则表示没有送签
  17. "contract_serial": "",
  18. "start_time": "0000-00-00", //合同开始时间
  19. "end_time": "0000-00-00", //合同结束时间
  20. "send_time": "2020-10-05 11:14:24", //甲方发送合同时间
  21. "sign_time": null, // 乙方签署时间
  22. "reject_time": null, // 审核时间
  23. "cancel_time": null, // 取消时间
  24. "success_time": null, // 合同存档时间
  25. "close_tips": true,// 是否关闭了到期提醒
  26. "expire_day": 1,// >0 表示还有N天过期,30天内才会有此值 =0 还未过期,离过期大于30天 =-1 已过期
  27. "sort": 0,
  28. "status": 1,
  29. "reason": null,
  30. "company_text":{},//甲方文字域内容
  31. "company_text_format":{"salary":{"value":"300","label":"薪水"},"work_pos":{"value":"上海","label":"岗位"}},//甲方文字域格式化后内容
  32. "employee_text": null,//乙方文字域内容
  33. "ext":{},//
  34. "created_at": "2020-10-05 12:01:25",
  35. "updated_at": "2020-10-06 15:22:49",
  36. "company":{},//签署主体
  37. "employee":{},//员工信息
  38. "contract":{},//合同信息
  39. "contract_info":{},//合同版本版本信息
  40. "sons":[],//关联协议信息
  41. "es_sign":{},//关联的e签保信息
  42. }
  43. ],
  44. }
  45. }
添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注