Z快拖车救援开放平台API

Version: 1.0.1

Z快拖车救援开放平台API、用户注册、发布救援信息。

Default response content-types: application/json

Schemes: http

Summary

Tag: 安全验证

Operation	Description
POST /oauth/token?grant_type=client_credentials	获得合作平台 Access Token
POST /oauth/token?grant_type=password	获得用户的 Access Token
POST /oauth/token?grant_type=refresh_token	刷新 Access Token

Tag: 用户

Operation	Description
POST /members	注册用户
PUT /members	更新已注册的用户信息
GET /members	返回当前第三方平台注册的用户列表
GET /members/{memberId}	按用户编号查找用户

Tag: 救援

Operation	Description
POST /jiuyuans	发布新道路救援信息
GET /jiuyuans	当前用户所发布的道路救援信息
GET /jiuyuans/{jiuyuanId}	按道路救援信息编号查找救援
GET /jiuyuans/{jiuyuanId}/confirm/{fapiao}/{price}	确认道路救援定单
GET /jiuyuans/{jiuyuanId}/complete	完成道路救援
GET /jiuyuans/{jiuyuanId}/cancel	取消道路救援
GET /jiuyuans/{jiuyuanId}/driver	获得接受报价救援司机的联系方式

Security

ehy_auth

Type: oauth2

Flow:: implicit
AuthorizationUrl:: http://api.ehuoyun.com/oauth
Scopes:: members_write: 代客户注册用户; members_read: 查询用户信息; jiuyuans_write: 发布道路救援信息; jiuyuans_read: 获取自己发布的道路救援信息

Paths

当前用户所发布的道路救援信息

GET /jiuyuans

Tags: 救援

获取当前用户所发布的道路救援信息


Authorization	Bearer Access Token	header	string
Member	如果是第三方平台Access Token，一定要传入Member Id参数，否则可以省略。	header	integer (int64)

application/json

200 OK: 成功返回查询的道路救援信息

Jiuyuan


ehy_auth	jiuyuans_read

发布新道路救援信息

POST /jiuyuans

Tags: 救援

application/json

要发布的道路救援信息

Jiuyuan


Authorization	Bearer Access Token	header	string

application/json

200 OK: 道路救援信息编号

Id
405 Method Not Allowed: 无效的道路救援信息


ehy_auth	jiuyuans_write

按道路救援信息编号查找救援

GET /jiuyuans/{jiuyuanId}

Tags: 救援

返回指定救援编号的道路救援信息


Authorization	Bearer Access Token	header	string
jiuyuanId	要查找的道路救援编号	path	integer (int64)

application/json

200 OK: 成功返回查找到的道路救援信息

Jiuyuan
400 Bad Request: 提供的道路救援编号不正确
404 Not Found: 没查到想对应编号的道路救援信息


ehy_auth	jiuyuans_read

取消道路救援

GET /jiuyuans/{jiuyuanId}/cancel

Tags: 救援

取消指定救援编号的道路救援信息


Authorization	Bearer Access Token	header	string
jiuyuanId	要取消的道路救援编号	path	integer (int64)

application/json

200 OK: 成功取消道路救援信息
400 Bad Request: 提供的道路救援编号不正确
404 Not Found: 没查到想对应编号的道路救援信息


ehy_auth	jiuyuans_write , jiuyuans_read

完成道路救援

GET /jiuyuans/{jiuyuanId}/complete

Tags: 救援

把指定救援编号的道路救援信息设置为已完成托运状态


Authorization	Bearer Access Token	header	string
jiuyuanId	要完成的道路救援编号	path	integer (int64)

application/json

200 OK: 成功完成道路救援信息
400 Bad Request: 提供的道路救援编号不正确
404 Not Found: 没查到想对应编号的道路救援信息


ehy_auth	jiuyuans_write , jiuyuans_read

确认道路救援定单

GET /jiuyuans/{jiuyuanId}/confirm/{fapiao}/{price}

Tags: 救援

把指定救援编号的道路救援信息的发票及价格信息


Authorization	Bearer Access Token	header	string
jiuyuanId	要确认的道路救援编号	path	integer (int64)
fapiao	是否需要发票	path	boolean
price	救援价格	path	number (float)

application/json

200 OK: 成功确认道路救援信息
400 Bad Request: 提供的道路救援编号不正确
404 Not Found: 没查到想对应编号的道路救援信息


ehy_auth	jiuyuans_write , jiuyuans_read

获得接受报价救援司机的联系方式

GET /jiuyuans/{jiuyuanId}/driver

Tags: 救援

只有接受报价后，才可以返回救援司机的联系方式


Authorization	Bearer Access Token	header	string
jiuyuanId	要查找救援司机联系方式的道路救援编号	path	integer (int64)

application/json

200 OK: 成功返回道路救援司机的联系方式

Driver
400 Bad Request: 提供的道路救援编号不正确
404 Not Found: 没查到想对应编号的道路救援信息


ehy_auth	jiuyuans_write , jiuyuans_read

返回当前第三方平台注册的用户列表

GET /members

Tags: 用户

分批次每次返回50个用户列表, 如果返回的用户数不足50个，代表没有更多记录。


Authorization	Bearer Access Token	header	string
Start	用户记录起始位置。	header	integer (int32)

application/json

200 OK: 成功返回用户信息

Member


ehy_auth	members_read

注册用户

POST /members

Tags: 用户

调用该API注册新用户，调用此API时，request header 必须包含api key.

要注册的用户数据

Member


Authorization	Bearer Access Token	header	string

application/json

200 OK: 返回成功注册的用户编号

Id


ehy_auth	members_write

更新已注册的用户信息

PUT /members

Tags: 用户

application/json

要更新用户信息

Member


Authorization	Bearer Access Token	header	string

application/json

200 OK: 成功更新用户编号
400 Bad Request: 用户信息不正确


ehy_auth	members_write

按用户编号查找用户

GET /members/{memberId}

Tags: 用户

返回指定用户编号的用户信息


Authorization	Bearer Access Token	header	string
memberId	要查找的用户编号	path	integer (int64)

application/json

200 OK: 成功返回查找到的用户信息

Member
400 Bad Request: 提供的用户编号不正确
404 Not Found: 没查到想对应编号的用户信息


ehy_auth	members_read

获得合作平台 Access Token

POST /oauth/token?grant_type=client_credentials

Tags: 安全验证

用合作平台申请的Client Id 和 Client Secret 换 Access Token, 此 Access Token 用于代客户注册用户.


grant_type	client_credentials	query	string client_credentials
client_id	e货运开放平台为第三方应用分配的 client id	query	string
client_secret	e货运开放平台为第三方应用分配的 client secret	query	string
scope	申请的访问权限，如：members_read	query	string

application/json

default: Access Token

获得用户的 Access Token

POST /oauth/token?grant_type=password

Tags: 安全验证

用车用户注册时的电话号码或邮件地址及密码换 Access Token, 此 Access Token 可发布道路救援信息.


grant_type	password	query	string password
client_id	e货运开放平台为第三方应用分配的 client id	query	string
client_secret	e货运开放平台为第三方应用分配的 client secret	query	string
username	登录的用户名	query	string
password	登录的密码	query	string
scope	申请的访问权限，如：members_read	query	string

application/json

default: Access Token

刷新 Access Token

POST /oauth/token?grant_type=refresh_token

Tags: 安全验证

用 Refresh Token 刷新 Access Token.


grant_type	refresh_token	query	string refresh_token
client_id	e货运开放平台为第三方应用分配的 client id	query	string
client_secret	e货运开放平台为第三方应用分配的 client secret	query	string
refresh_token	Refresh Token	query	string

application/json

default: Access Token

Schema definitions

Contact: object

联系人信息

id: integer (int64): 联系人编号
name: string: 联系人称呼
phone: string: 联系电话

Driver: object

司机信息

id: integer (int64): 司机信息编号
member: integer (int64): 对应用户编号
type: DriverType: 司机类型
openId: string: 绑定的微信号
city: integer: 司机所在城市ID
name: string: 司机姓名
license: string: 驾驶证号码
fileNumber: string: 档案编号
licenseClass: string: 驾驶证类别
addressLine: string: 当前地址
gender: boolean: 司机姓别
bod: string (date): 出生日期
issued: string (date): 发证日期
expires: string (date): 证件过期日期
rating: number (float): 客户评分
carNumber: string: 车牌号
verified: boolean: 是否通过认证
busy: boolean: 闲忙状态
createDate: string (date): 创建时间
editDate: string (date): 修改时间

DriverType: string , x ∈ { BANCHE , JIUYUAN }

Id: object

注册用户，发布救援时返回的Id

id: integer (int64): 编号

Jiuyuan: object

救援信息基本属性

id: integer (int64): 救援信息编号
client: integer (int64): 合作平台编号
orderNo: string: 救援定单编号，是以字母 JY 开头，加日期的字符串
name: string: 救援信息名称
description: string: 救援信息描述
listBy: integer (int64): 发布救援信息的用户编号
contact: Contact: 发布救援信息的联系人信息
type: JiuyuanType: 救援类型
series: integer: 轿车型号
fapiao: boolean: 是否需要发票
increases: integer: 加价次数
startAdcode: integer: 起始城市编码
startLocation: string: 起始位置经纬度
startAddress: string: 起始详细地址
endAdcode: integer: 目的城市编码
endLocation: string: 目的位置经纬度
endAddress: string: 目的详细地址
distance: number (float): 拖车距离
status: JiuyuanStatus NEW: 当前状态
targetPrice: number (float): 目标价格
createDate: string (date): 创建时间
editDate: string (date): 修改时间

JiuyuanStatus: string , x ∈ { NEW , ACCEPTED , CANCELED , COMPLETED }

JiuyuanType: string , x ∈ { SHIP , TOW , BATTERY , TIRE , GAS , LOCKOUT , QUICK_FIX }

Member: object

注册用户信息

id: integer (int64): 用户编号
name: string: 用户名称
email: string: 邮件地址
phoneNumber: string: 电话号码
password: string (password): 登录密码
lastLogin: string (date): 最后登录时间
createDate: string (date): 创建时间
editDate: string (date): 修改时间