@lina 2019-09-04T17:39:32.000000Z 字数 4588 阅读 456

闪签云 1.0 小程序接口文档

列表项
秒云达 1.0 后台

1、项目约定

1.1 基本约定

1.1.1 API Base Url

【测试url】http://api.qian.guangying.link/api

【线上url】/api

1.1.2 鉴权字段(身份标识)

X-location : [string] 坐标 lng-lat 请求头带此字段

X-unique-key : [string] 服务端下发的标识，取window.uniqueKey 请求头带此字段

X-city : [string] 所在城市名称请求头带此字段

X-platform-code : [string] 平台标识字段,所有请求均需要此字段，取window.platformCode 请求头带此字段

1.1.3 HTTP请求中字段要求

POST请求Content-Type为：Content-Type:application/x-www-form-urlencoded

文件上传时Content-Type为：Content-Type:multipart/form-data

对于：Content-Type:application/json：Content-Type:application/xml不保证完全支持，请谨慎使用

1.2 通用接口

1.2.1 通用接口URL

【线上url】待定

【测试url】http://admin.qian.guangying.link/api

【线上url】/api/

1.2.2 上传图片

通用图片上传文件服务

请求URL

POST
/image

请求参数

file : 文件

响应

{
    error_code: 0,
    data: {
        url: 'http://xxx'
    }
}

url : [string] 文件的访问URL

1.2.3 验证码图片

注：请求图片时，需解析图片的cookie，不然无法认证

GET
/captcha

1.2.4 发送短信

POST
/verifycode

请求参数

captcha_code : [string] 图形验证码

phone : [string] 手机号

响应

{
    error_code: 0,
    data: {
    }
}

1.3 通用响应字段

1.3.1 状态字段

status: [int] 服务器状态码，0 为正常状态，异常状态待定。

msg：[string] 错误信息&提示信息

1.3.2 数据字段

data: [object] 数据字段，所有响应数据都在此字段中

list: [array]，当返回数据为列表时会将数据放在该字段

1.3.3 分页字段

page: [int] 当前页码，默认为1

total: [int] 总页数

pageSize: [int]
每页数量：本项目常用page_size==10

示例

{
    status: 0,
    msg: '',
    data: {
        list: [{
            key: value
        }],
        total: 23
    }
}

2、数据结构

2.1 常用字段含义

2.1.1 性别字段

gender:[int]

0: 未知
1: 男
2: 女

2.1.2 是否启用状态

status: [int]

0:未启用
1:启用

2.1.3 签约状态

status: [int]

1签约申请，2待签约，3已签约，4已驳回，5已取消

2.2 核心结构

2.2.1 个人简历信息

{
    real_name      varchar(16)                           not null,
   phone          varchar(16)                           not null,
   id_number      varchar(32)                           not null comment '身份证',
  age            int(3)      default 0                 not null comment '年龄',
  gender         int(1)      default 0                 not null comment '0未知 1男 2女',
  nation         varchar(12) default ''                not null comment '民族',
  marital_sts    int(1)                                not null comment ' 1未婚 2已婚 3离异',
  political_sts  int(1)                                not null comment '1共产党员 2共青团员 3群众',
  acct_type      int(1)                                not null comment '户口类型，0农村，1城市',
  acct_prc_id    int                                   null comment '户籍省份id',
  acct_prc_name  varchar(16)                           null comment '户籍省份',
  acct_city_id   int                                   null comment '户籍城市id',
  acct_city_name varchar(12)                           null,
  acct_coy_id    int                                   null comment '户籍区/县id',
  acct_coy_name  varchar(255)                          null comment '户籍区、县名称',
  acct_addr      varchar(16)                            null comment '户籍详细地址',
  province_id    int                                   null,
  province_name  varchar(12)                           null,
  city_id        int                                   null,
  city_name      varchar(12)                           null,
  county_id      int                                   null,
  county_name    varchar(255)                          null,
  addr           varchar(255)                          null,
  em_contact_name         varchar(16)                           null comment '紧急联系人姓名',
    em_contact_phone        varchar(32)                           null comment '紧急联系人电话',
    em_contact_relationship varchar(32)                           null comment '与紧急联系人的关系',
    id_card_front           varchar(256)                          null comment '身份证正面照片',
    id_card_back            varchar(256)                          null comment '身份证反面照片'
  company_id     int         default 0     not null comment '所属用人单位id',(company对象里包含名称）
  work_pos       varchar(16)                           null comment '岗位',
  work_exp 数组是工作经验，
  employee_edu 数组是学历信息
}

2.2.2 签约信息

{
    em_id       int                                   not null comment '签约人',
    employee 表示签约人信息，
  ad_user_id  int                                   not null comment '处理人id，管理员id',
  ad_user 表示管理员信息，
  work_pos    varchar(16) default ''                not null comment '岗位',
  company_id  int         default 0                 not null comment '用人单位id' ，
  company 对象表示公司信息，
  entry_date  date                                  null comment '入职日期',
  contract_id int         default 0                 null comment '合同id',
  salary      decimal(15, 2) default 0.00              not null comment '薪资',
  contract 对象合同信息，
  apply_time  timestamp   default CURRENT_TIMESTAMP not null comment '申请时间',
  status      int(1)        not null comment '1签约申请，2待签约，3已签约，4已驳回，5已取消',
  reason      varchar(256)                          null comment '驳回原因',
}

2.2.3 合同信息

{
  contract_name varchar(32)                         not null comment '合同名称',
  contract_body varchar(32)                         not null comment '合同主体',
  company_id    int                                 not null comment '用人单位id',
  sign_year     int(2)                              not null comment '合同年限',
  file_url      varchar(64)                         not null comment '合同文件地址',
  status        int(1)    default 1                 not null comment '0禁用，1启用',
}

2.2.4 管理员信息

{
  username   varchar(32)                            not null,
  name       varchar(16)                            null comment '姓名',
  phone      varchar(16)                            null comment '电话',
  email      varchar(32)                            null comment '邮箱',
  status     int(1)       default 1                 not null comment '0 禁用，1启用',
}

3、接口列表

3.1 小程序登录

3.1.1 登录

请求URL

POST
/weixin/login

请求参数

code: [string]

{
    "status": 0,
    "msg": "",
    "data": 
    {
        "session_token": "xxxx", // 会话 token 信息
        "em_id": 0,  // 为0表示未提交过简历信息，大于零得需要调用下面接口判断具体处于哪个状态
    } 
}

3.1.2 首页状态

请求URL

GET
/em_status

请求头需要有X-auth-token的信息

请求参数

无

{
    "status": 0,
    "msg": "",
    "data": 
    {
        "reason": "驳回原因",
        "company_name": "申请的公司名称",
        "status": 1, // 签约的状态，同表sign_apply中的状态，1签约申请，2待签约，3已签约，4已驳回，5已取消
        "verify_status": 0,  // 实名认证状态，同user_wechat表中verify_status状态，0 待实名， 1实名中，2实名成功 3实名失败
    } 
}

3.2 简历相关

3.2.1 提交简历

请求URL

POST
/employee

请求头需要有X-auth-token的信息

请求参数

基本简历信息字段: [string] 略

employee_edu: [array] 教育情况【必填】

work_exp: [array] 工作情况【必填】

ad_user_id: [int]

'raw_data'、'iv'、'signature'、'encrypted_data'小程序授权后的信息

响应

{
    "status": 0,
    "msg": "",
    "data": null
}

3.2.2 更新简历（处于待签约和已签约不可以修改简历）

请求URL

PUT
/employee

其他内容和更新一致

3.2.3 获取简历

请求URL

GET
/employee

请求头需要有X-auth-token的信息

3.4 其他接口(基本上都要请求头上带上token）

3.4.1 获取字典接口（例如获取学历的类型）

请求URL

GET
/dict/{dict_item}

dict_item为Edu_Type则表示获取学历类型的字典

请求参数

无

{
    "status": 0,
    "msg": "",
    "data": [
    {
        "dict_key": "junior",
        "dict_value": "初中"
    }, // 还有其他的，具体见dictionary表
    ],
}

3.4.2 获取所有岗位

请求URL

GET
/work_pos

请求参数

无

{
    "status": 0,
    "msg": "",
    "data": [
        "A岗位", "B岗位","C岗位",
    ],
}

3.4.3 获取所有处理人（人事专员）

请求URL

GET
/handlers

请求参数

无

{
    "status": 0,
    "msg": "",
    "data": [
    {
    'id': 12,
    'name': xxx
    }
    ]
}

3.4.3 获取所有用人单位

请求URL

GET
/companies

请求参数

无

{
    "status": 0,
    "msg": "",
    "data": [
    {
    'id': 12,
    'company_name': xxx
    }
    ]
}

闪签云 1.0 小程序接口文档

1、项目约定

1.1 基本约定

1.1.1 API Base Url

1.1.2 鉴权字段(身份标识)

1.1.3 HTTP请求中字段要求

1.2 通用接口

1.2.1 通用接口URL

1.2.2 上传图片

1.2.3 验证码图片

1.2.4 发送短信

1.3 通用响应字段

1.3.1 状态字段

1.3.2 数据字段

1.3.3 分页字段

2、数据结构

2.1 常用字段含义

2.1.1 性别字段

2.1.2 是否启用状态

2.1.3 签约状态

2.2 核心结构

2.2.1 个人简历信息

2.2.2 签约信息

2.2.3 合同信息

2.2.4 管理员信息

3、接口列表

3.1 小程序登录

3.1.1 登录

3.1.2 首页状态

3.2 简历相关

3.2.1 提交简历

3.2.2 更新简历（处于待签约和已签约不可以修改简历）

3.2.3 获取简历

3.4 其他接口(基本上都要请求头上带上token）

3.4.1 获取字典接口（例如获取学历的类型）

3.4.2 获取所有岗位

3.4.3 获取所有处理人（人事专员）

3.4.3 获取所有用人单位

内容目录