1 接口声明及约定

1.1接口协议

除非特殊指定,默认请求方式均为HTTP/POST方式。

1.2返回数据格式

除非特殊指定,默认返回数据格式均为JSON格式。

1.3字符编码

除非特殊指定,默认字符编码均为UTF-8编码格式。

1.4 URL编码

由于可能包含非ASCII字符和路径非法字符,因此所有API参数,均必须使用urlencode方式表达。

1.5坐标系

除非特殊指定,所有涉及坐标位置的参数,默认使用高德经纬度坐标。

1.6 API域名

首汽约车API开发域名为:https://dev-taxi-openapi.01zhuanche.com

首汽约车API测试域名为:https://test-taxi-openapi.01zhuanche.com

首汽约车API预生产域名为:https://pre-taxi-openapi.01zhuanche.com

首汽约车API线上域名为:https://taxi-openapi.01zhuanche.com

下文API域名用SQYC_DOMAIN代替。

1.7 SQYCKEY密钥

sqycKey用于合作方访问首汽约车提供的API接口时,首汽约车对访问者身份(第三方)进行鉴权验证。示例sqycKey=sqyc8f9782735fbae831d58005b, 参数是首汽约车颁发给合作方的唯一字符串。双方须严格保密sqycKey密钥,防止非法访问,sqycKey的具体值双方约定即可。

1.8 sign生成算法

sign作为API访问的请求参数之一,是首汽约车与合作方双方进行身份验证的有效凭证,sign生成算法:

1)首先将所有输入参数对(不包括sign参数或者空值的参数)按照键的值进行ksort排序,例如:

"channel" => "peopledigital",

"riderPhone" => "13102001523",

"riderName"=> "%e5%bc%a0%e4%b8%89",

"timeStamp "=>1404099226,

2)将排序之后数组按照如下格式连接起来,最后拼接上“&sqycKey=xxx”字符串,对字符串进行md5得到的就是参数中的sign:

$sign=md5(“channel=gaodeMap&riderName=%e5%bc%a0%e4%b8%89&riderPhone=13102001523&timeStamp=1404099226&sqycKey=xxx”)

3)最终的url为(此处以get请求举例说明,对接时接口还是post形式请求。)

http://xxx.01zhuanche.com/order?channel=peopledigital&riderName=张三&riderPhone=13102001523&timeStamp=1404099226&sign=c46ee31aafa8d490429ca695261a758f

双方须严格保密sign生成算法,防止非法访问。下文中涉及的所有API接口访问都需要使用sign作为请求参数之一。

Copyright © 首约科技(北京)有限公司 2020 all right reserved,powered by Gitbook该文件修订时间: 2024-09-10 08:00:38

results matching ""

    No results matching ""