文档中心

1. 接口说明

调用方访问授权后，将返回的授权信息缓存半小时（缓存过期或调用服务时返回401 => access_token不合法或已过期,再重新申请授权），不需要每次调用接口都申请一次授权。

2. 请求信息

请求地址：https://api.es.xiaojukeji.com/v2/Auth/authorize
请求方式：POST
Content-Type:application/json

3. 请求参数

字段名称	字段类型	是否必填	字段说明
client_id	string	是	申请应用时分配的client_id
client_secret	string	是	申请应用时分配的client_secret
grant_type	string	是	请求的类型，请填写固定值`client_credentials`
phone	string	是	当前用户的手机号
timestamp	int32	是	调用接口时间对应的时间戳，精确到秒级
sign	string	是	签名（注：本接口的传参都要参与签名）签名算法

提示

1、client_id、client_secret、phone字段值，请使用管理员账号登录到滴滴企业开放平台官网查询（https://open.es.xiaojukeji.com/open/App/index）

2、phone必须已导入到滴滴，否则会返回406业务错误码

4. 请求示例

curl --location --request POST 'https://api.es.xiaojukeji.com/v2/Auth/authorize' \
--header 'Content-Type: application/json' \
--data-raw '{"client_id":"diditestclient","client_secret":"diditestpass","grant_type":"client_credentials","phone":"11000012923","timestamp":1566733837,"sign":"caf7b797305a413a55663787da193fdf"}'

5. 返回值结构

字段名称	字段类型	是否必需	字段说明
errno	int32	否	报错时返回，错误码，不等于0
errmsg	string	否	报错时返回，错误信息
data	object	否	报错时返回，且为null
access_token	string	否	未报错返回，授权access token，调用其他接口需要该值
expires_in	int32	否	未报错返回，access_token的生命周期，单位：秒
token_type	string	否	未报错返回，access_token类型
scope	string	否	未报错返回，权限范围

6. 返回值示例

正常返回

{
    "access_token":"5952a463ff5c2272e6340cc9f52a58a880057ac0",
    "expires_in":1800,
    "token_type":"Bearer",
    "scope":"selfcar"
}

异常返回

{
    "errno":10001,
    "errmsg":"timestamp过期",
    "data":null
}

7. 错误码说明

业务错误码

错误码	错误信息	错误说明
400	非法的client_id	client_id无效
402	未传当前用户手机号或手机号不合法	入参中手机号为空或未传phone字段或手机号格式错误
406	该用户不存在，请管理员添加后再使用	参数中的手机号phone不在滴滴账户中（`更新管理员账号或者管理员离职时极易发生，所以该手机号最好使用一个无真实员工的手机号，或者管理员在离职前先更新该手机号`）
408	参数错误，未正确传输timestamp	timestamp为0 或者未传
412	client_id和client_secret为必填项	参数中client_id或client_secret没有传
500	access_token生成失败，请稍后重试	滴滴侧服务异常，需重试
10001	timestamp过期	滴滴侧接收到请求的时间与传参中的timestamp 差值大于60秒或者小于0，即`(滴滴侧接收到请求的时间 - timestamp) > 60 or (滴滴侧接收到请求的时间 - timestamp) < 0`，该校验是防止业务方请求被篡改
10002	ip验证失败xxxxx	业务方请求的外网IP不在滴滴配置的白名单中，请参照附件 IP不在IP白名单的解决方案自行解决
19999	sign签名验证失败，无权访问该接口	滴滴侧根据业务方入参重新计算的sign 与业务方传参中的sign 不一致，请参照附件签名验证失败解决