请求地址

https://api.es.xiaojukeji.com/river/Member/single

返回数据格式

JSON

请求方式

POST

是否需要登录

是 关于登录授权，参见 如何登录授权

访问授权限制

暂无

请求头格式

Cntent-Type:application/json

请求参数

参数 类型 必填 描述
client_id string yes 申请应用时分配的AppKey
access_token string yes 授权后的access token
timestamp bigint yes 当前时间戳，精确到秒级
company_id string yes 企业ID
data string yes 员工数据json格式
has_card_info int no data 中是否包含证件信息，0：不包含，1：包含， 当data中包含证件信息时，此字段必须传1
sign string yes 签名

员工信息（data对应数组中每条记录中字段）

名称 类型 必选 描述
phone string yes 员工手机号
realname string yes 员工姓名(最多50个字符)
employee_number string no 员工ID（员工在公司的员工号）(最多32个字符)
email string no 邮箱（最多 64 字符）
system_role int no 系统角色(0-车辆预定人员，1-普通管理员，2-超级管理员；默认为0)tip：老接口不再使用，建议使用role_ids更新角色
role_ids string no 角色（默认为员工），通过角色获取API 。可以填多个，以_分隔。初始管理员、主管不支持新增
immediate_superior_phone string no 员工直属上级的手机号码（需为本企业中已存在账号），直属上级可在审批流中担任审批人
residentsname string no 常驻地中文,可通过城市查询接口获得地级市名称
use_company_money int no 是否企业支付余额（0-否，1-是，默认为0）
注：检查员工身上是否有制度，制度和企业支付权限都有才能企业支付
total_quota string no 每月配额(单位：元，可为小数)
is_remark int no 叫车时备注信息是否必填(0-选填，1-必填，2-按制度填写；默认为0)
budget_center_id bigint no 所在部门ID（新），默认为1（企业）。通过成本中心查询api获取id（类型为1）
regulation_id string no 用车制度ID（获取方式，可以填多个，以_分隔，如 123_456_789）
注:若该员工的所有制度都是在es后台通过部门/职级/全员方式分配，则员工身上的制度字段不用传；同时注意检查use_company_money字段是否传输，制度和企业支付权限都有才能企业支付。
project_ids string no 所在项目ID。获取方式，可以填多个，以_分隔。通过成本中心查询api获取id（类型为2）
invoice_info json no 开票主体信息，必须为json串，且需包含纳税人主体字段taxpayer_subject(json格式例如"{"taxpayer_subject":"xxxx有限公司"}")
legal_entity_id string no 滴滴侧公司主体 ID；获取方式
rank_id string no 滴滴侧职级ID，获取方式
out_rank_id string no 外部职级ID，当 rank_id 和 out_rank_id 同时存在时，以 rank_id 为主
english_surname string no 英文姓，长度不大于26个字符，且只支持数字、字母、下划线和空格
english_name string no 英文名，长度不大于26个字符，且只支持数字、字母、下划线和空格
nickname string no 昵称
sex int no 性别，0.不填 1.男 2. 女，默认为0
birth_date string no 出生日期，格式2000-01-01（需用AES算法加密）
card_list []object no 证件信息

证件信息(card_list每个记录的字段)

名称 类型 必选 描述
card_type int yes 证件类型:
1. 身份证
2. 护照
3. 港澳台居民居住证
4. 台胞证
5. 军官证
6. 回乡证
7. 外国人永久居留身份证
8.往来港澳通行证
9. 公务护照
10. 外交护照
11.其他
card_no string yes 证件号码（需用AES算法加密）
expire_date string no 证件过期日期，格式：2050-01-01（需用AES算法加密）

注意事项

1、参数data为json字符串格式(传参时

{
    "phone":"18611869995",
    "realname":"张三",
    "employee_number":"",
    "email":"dys@didichuxing.com",
    "system_role":0,
    "use_company_money":1,
    "total_quota":10000,
    "is_remark":0,
    "regulation_id":"5489198484344538189_5489709520894035023"
}

2、常驻地目前只支持如“北京”、“北京市”、“北京市海淀区”格式，不支持“海淀区”此类格式，如果传参中带了区县则必须把“市”、“区“、”县”字段都带上。

请求参数

client_id = "client_id_test", "access_token" = "access_token_test", timestamp = 1565875844, company_id = "12345678980"
data原始值：phone = 11000001234, realname = "张三", employee_number = "D123456", email = "1234@test.com"
data转换为json串后为：{"phone":11000001234,"realname":"张三","employee_number":"D123456","email":"1234@test.com"}
sign_key = "sign_key_test"

计算签名

加密前的字符串：access_token=access_token_test&client_id=client_id_test&company_id=12345678980&data={"phone":11000001234,"realname":"张三","employee_number":"D123456","email":"1234@test.com"}&sign_key=sign_key_test&timestamp=1565875844
计算得到的签名：sign = md5("access_token=access_token_test&client_id=client_id_test&company_id=12345678980&data={"phone":11000001234,"realname":"张三","employee_number":"D123456","email":"1234@test.com"}&sign_key=sign_key_test&timestamp=1565875844") = 7473eb9bff6e1aa352dd2e433ed1924a

请求示例

curl -X POST -H "content-type:application/json" \
-d '{"client_id":"client_id_test","access_token":"access_token_test","timestamp":1565875844,"company_id":"12345678980","data":"{\"phone\":\"11000001234\",\"realname\":\"张三",\"employee_number\":\"D123456\",\"email\":\"1234@test.com\"}","sign":"7473eb9bff6e1aa352dd2e433ed1924a"}' \
https://api.es.xiaojukeji.com/river/Member/single

返回参数说明

返回值字段 字段类型 字段说明
errno int 0表示成功，非0表示失败
errmsg string errno=0时为常量"SUCCESS"，errno!=0时为错误信息
data object 返回值对象
data.id bigint 员工在滴滴企业平台的ID
data.phone string 员工手机号

返回示例

// 添加成功
{
    "errno": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 1125904406565093,
        "phone": "19811110001"
    }
}
// 添加失败
{
    "errno":50202,
    "errmsg":"添加员工失败 (员工已存在)",
    "data":{
        "member_id":"1125914462311111",
        "phone":"19811110001"
    },
    "request_id":"i+2SqRl3Ack6In9eSdNeBTRxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

接口错误解决方案

通用错误解决文档

  1. 4xx 错误
  2. 1xxx 错误

50202(添加员工失败(xxxxxx))

xxxxxx有以下可能：

  1. 请求间隔不能小于150毫秒,请稍后重试
  2. 公司已停
  3. 管理员已注销
  4. 只有超管和初始超管才能添加员工
  5. 一次只能添加一名员工 http://api.es.xiaojukeji.com/river/Member/single 该接口每次只能添加一个员工
  6. 员工已存在 员工手机号、邮箱、员工工号必须唯一。同时返回该员工对应的滴滴id、手机号
  7. 员工处于待确认状态,请联系员工自行确认加入 员工已在A企业，现在B企业去添加该员工，此时B企业添加失败，员工进入B企业的待确认列表中，会在企业APP上的卡片提示员工，是否加入B企业; 员工确认链接会通过data.url返回，可以让员工点击链接进行操作
  8. 员工存在于其他公司,已经通知该员工加入企业,请联系员工自行确认加入 与7的区别是，提示这个错误时，会给员工发送短信提示是否加入新企业 员工确认链接会通过data.url返回，可以让员工点击链接进行操作
  9. 部门不存在 调用成本中心查询接口,参数中的type=1获取所有部门的信息,返回值中的id(即部门id)就是员工添加接口的budget_center_id
  10. 项目不存在 调用成本中心查询接口,参数中的type=2获取所有部门的信息,返回值中的id(即部门id)就是员工添加接口的project_ids
  11. 制度不存在 调用用车制度列表接口,返回值中的regulation_id就是员工添加接口的regulation_id

50242(添加员工失败(您最多可以导入X员工,如需导入更多员工,请购买更多的许可))

  1. 这是由于贵企业购买了按许可数的高级费控版本，一旦已导入的员工数量达到了X，则不能再添加，除非购买更多的许可数(操作方式：登录滴滴企业ES后台——>企业设置——>增值服务)

results matching ""

    No results matching ""