北迈云开放服务基于北迈云强大的全车件供应链以及北迈自主研发的汽车配件数据库系统BM.DC,为拥有自主研发能力的平台或终端提供基础数据查询以及配件供应链相关服务。
电商平台或APP终端可通过北迈云开放服务可以:
1、集成北迈车型库、配件分类库以及配件相关库存及报价并自主对接订单的相关服务。
2、通过配件OE号,基于北迈云配件标准化服务,可查询配件适配车型、替换号及相关技术参数,标准化后的配件可让终端车主更好的识别配件是否适合自己的需求。
时间: | |
标题: | |
内容: |
|
感谢您对北迈云的支持,您在进行技术对接和集成的过程中如有任何问题,需求或意见,可随时发送邮件,我们会第一时间给您回复。
联系方式:yun@beimai.com
客服QQ:2853731503
温馨提示:
发送邮件时,请提供您的企业名称、联系方式等信息,以便我们能及时与您取得联系。
如果您想为用户提供北迈云商品导购服务,请申请成为开发者,并创建应用。
北迈云为网站应用开放以下API权限:
类目服务、通用服务、配件服务、订单服务、财务服务、支付服务、聊天服务、工时费(dc) 服务、运费相关(dc) 服务、车架号解析(dc) 服务、Oem号服务、bmno相关服务、品牌号服务、标准名称服务、主机厂服务、车系服务、配件属性服务
网站应用接入规则:
创建网站应用需要您注册成为北迈云的开发者
创建网站应用流程:
申请成为开发者-》创建新应用-》北迈云审核应用-》上线运行
1、申请成为开发者注册成为北迈云会员:如果您还不是北迈云用户,请先注册北迈云个人账号,
注册地址:http://open.beimai.com/login/register
2、创建应用 登陆北迈云电商平:http://open.beimai.com/login
3、等待北迈云审核
4、上线运行。审核通过后可上线运行。
注:本篇介绍如何注册北迈云开发者,创建应用。
1、注册北迈云开发者 注册地址:http://open.beimai.com/login/register
1、点击“创建新应用”
2、保存成功后此时应用的状态为“审核中”
3、进入应用列表,点击“编辑”,进入应用详情,这里可以查询应用的相关密钥,及修改相关信息。
4、北迈云审核通过,应用为上线运行状态。
获取访问令牌access_token
使用创建应用时分配的AppKey及AppSecret,通过Http Post方式换取Token(访问令牌,即Access token),北迈云会以json格式返回数据。
接口http://oauth2.beimai.com/oauth2.0/access_token参数说明
序号 | 参数名 | 必选 | 参数说明 |
---|---|---|---|
1 | client_id | true | 创建应用时的Appkey |
2 | client_secret | true | 创建应用时生成的密钥AppSecret |
3 | scope | true | 权限参数,API组名串。多个组名时,用","分隔,目前支持参数值:read |
4 | redirect_uri | true | 应用的回调地址,必须与创建应用时所填回调页面url一致 |
5 | grant_type | true | 授权类型(缺省为code,可选值有code、client) 目前支持参数值:client |
返回字段说明:
序号 | 字段名 | 字段说明 |
---|---|---|
1 | expires_in | 失效时间(从当前时间算起,单位:秒) |
2 | refresh_token | 刷新令牌 |
3 | access_token | 访问令牌 |
4 | expires_time | 访问令牌失效时刻(UNIX时间戳,单位:毫秒) |
可以参考如下代码获取AccessToken:
用户只需要按照北迈云的规范拼装一个正确的URL,通过http请求到北迈云接口,即能获取到所需的数据。
环境入口释义:调用API时,需要传入如下地址,获取相应环境下的数据。 http调用入口地址(即server_url):http://api.beimai.com/routerjson
调用API时,必须传入系统级参数和对应的应用级参数。各个API的输入参数和返回结果详见API文档。
①系统级参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
method | String | 是 | API接口名称 |
access_token | String | 是 | 北迈云分配给用户的令牌,通过授权获取,方法详见授权说明。如API文档上标识为“是”,则调用时均需要传入。 |
app_key | String | 是 | 应用的app_key |
sign | String | 是 | 签名 |
timestamp | String | 是 | 时间戳,指定的日期和时间距 1970 年 1 月 1 日午夜(GMT 时间)之间的毫秒数,例如:1493019206272。北迈云API服务端允许客户端请求时间误差为10分钟 |
version | String | 是 | API协议版本,可选值:1.0. |
②应用级参数
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
fields | String | 否 | 设置需要传递的字段列表,字段之间用","分隔。 |
如下为北迈云应用级参数拼装示例
名称 | 类型 | 描述 |
---|---|---|
param_json | String | 标准json 类型,而且是按照字母先后顺序排序的,如{"brandId":1,"step":1} |
调用API时需要对请求参数进行签名,北迈云服务器端会验证请求参数是否合法。
加密规则
① 所有请求参数按照字母先后顺序排列
例如:将access_token,app_key,method,timestamp,version,param_json 排序为access_token,app_key,method,param_json,timestamp,version
② 把所有参数名和参数值进行拼装
例如: {"access_token":xxx,"app_key":xxx,"method":xxx,"param_json":xxx,"timestamp":xxx,"version": "1.0" }
③ 把appSecret夹在字符串的两端
例如:appSecret+XXXX+appSecret
④ 使用MD5进行加密
示例(以下示例只体现逻辑)
调用beimai.catalog.read.getCarModel,假设app_key=yourappkey、appSecret=yourappSecret、access_token=yourtoken
1) 输入参数
access_token=yourtoken
app_key=yourappkey
method=beimai.catalog.read.getCarModel
timestamp=1493019206272
version =1.0
param_json=
{
"brandId":1,
"step":1
}
2) 把参数按照字母顺序排列
access_token=yourtoken
app_key=yourappkey
method=beimai.catalog.read.getCarModel
param_json=
{
"brandId":1,
"step":1
}
timestamp=1493019206272
version =1.0
3) 连接参数名与参数值,并在首尾加上appSecret
yourappSecret{"access_token":yourtoken,"app_key":yourappkey,"method":"beimai.catalog.read.getCarModel",
"param_json":{"brandId":1,"step":1},"timestamp":1493019206272,"version":"1.0"}yourappSecret
4) MD5加密
调用API时,将所有的参数转换成UTF-8编码,然后进行拼装,通过浏览器访问 该地址即可成功调取一次接口。
授权API调用URL示例(仅为示例):
http://api.beimai.com/routerjson?access_token= yourtoken &app_key=you
rappkey&method=beimai.catalog.read.getCarModel¶m_json=%7B%22brand
Id%22%3A1%2C%22step%22%3A1%7D×tamp=1493022758765&version=1.0&sig
n=025706ebeba94cc22482651c7e1c5e84
所有的API请求和响应数据编码皆为UTF-8格式,URL里的所有参数值请做urlencode编码
API请求的应用级参数需要转换成json格式,例如:param_json={"brandId":1,"step":1}
json格式应为标准的json
目前只支持返回结果是json格式
所有API请求和响应内的日期格式都为yyyy-MM-dd HH:mm:ss,注意小时格式是24小时制,例 如:2011-07-21 20:23:30
API接口的错误信息在http response body内
签名方式为 md5(appsecret + JSON字符串({key:value, key:value, .... }) + appsecret),其中
key、value对是除签名所有请求参数按key做的升序排列,value无需编码。
①API平台错误 ② 应用级错误
此内容仅针对北迈云接口层级的错误code做出解释。
如返回的错误code>2000,为北迈云业务层问题,请将您的请求url和返回结果发邮件至 yun@beimai.com
① API平台错误
这种错误一般是由于用户的请求不符合各种基本校验而引起的。用户遇到这些错误的返回首先检查应用的
权限、频率等情况,然后参照文档检验一下传入的参数是否完整且合法
错误码 | 错误中文描述 |
---|---|
1000 | 未知错误 |
1001 | 非法访问 |
1003 | 用户未授权 |
1004 | 登录失败 |
1011 | 缺少client_id参数 |
1012 | 缺少client_secret参数 |
1013 | 缺少scope参数 |
1014 | 缺少redirect_uri参数 |
1015 | 缺少code参数 |
1016 | 缺少state参数 |
1017 | 无效的grant_type |
1018 | 缺少refresh_token参数 |
1019 | 缺少access_token参数 |
1020 | 缺少timestamp参数 |
1021 | 缺少version参数 |
1022 | 缺少sign参数 |
1023 | 无效的access_token,请确认是client_id申请的token |
1024 | 请求超时(超时时间为10分钟) |
1025 | 无效的签名sign |
1026 | 无效的version(目前可选有:1.0) |
1027 | 无效的client_id |
1028 | 缺少methd参数 |
1029 | 无效的method参数 |
1030 | 无权访问该方法 |
② 应用级错误
这种错误一般是由于服务端(服务提供者)异常引起的。用户遇到这类错误需要隔一段时间再重试就可以解决。
错误码 | 错误中文描述 |
---|---|
2000 | 输入业务参数有误 |
2001 | 操作数据库失败 |