959999API接口接入规范
| API接口接入规范 | 《国鑫OpenAPI 接口接入规范.pdf》 |
API统一的规范的格式
1. https://{domain}/{type}/{version}/{resource}/{query_string}
具体参数介绍如下表格
| domain | 国鑫开放平台域名 |
| type | public : 免授权API rest : 授权类API |
| version | 接口版本 |
| resource | 对外部的资源名称 |
| query_string | sf_appid : 应用编号 sf_appkey : 应用服务安全key access_token : 授权类API的访问令牌 |
*注：接口均为https协议，保证数据信道的安全性。请求的消息体使用JSON格式组织数据。
接口报文格式
1、 接口采用JSON统一的格式，报文分报文头和报文体信息，报文请求消息头格式如下表格。
| 字段名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| head | |||
| transType | String(3) | 是 | 交易类型 目前支持的响应交易类型如下： 编码描述 200订单交易 201订单结果通知 202订单确认 203订单结果查询 204订单筛选 205电子运单图片下载 250基础服务查询 251附加服务信息查询 300ACCESS_TOKEN查询 301ACCESS_TOKEN申请 500路由推送 501路由查询 503路由推送申请申请 504路由增量查询 600供应商信息提交 601商品信息提交 602入库单信息提交 603出库单信息提交 604入库单状态查询 605出库单明细查询 606出库单状态查询 607库存查询 608取消出库单 609出库单状态及明细推送 610入库单明细推送 611出库单发票接口 |
| transMessageId | String(18) | 是 | 交易流水号格式如：YYYYMMDD+流水号{10},例如:201404120000000001,此流水号唯一不能重复 |
| body | 否 | ||
| ...... | 根据交易类型和交易接口而定 |
2、 接口采用JSON统一的格式，报文分报文头和报文体信息，报文响应消息头格式如下表格。
| 字段名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| head | |||
| transType | String(3) | 是 | 交易类型 目前支持的响应交易类型如下: 编码描述 4200下单交易 4201订单去确认发货 4202订单结果查询 4203订单筛选 4204订单筛选结果 4205电子运单图片下载 4250基础服务查询 4251附加服务查询 4300ACCESS_TOKEN查询 4301ACCESS_TOKEN申请 4500路由推送 4501路由查询 4503路由增量信息申请 4504路由增量查询 4600供应商信息提交 4601商品信息提交 4602入库单信息提交 4603出库单信息提交 4604入库单状态查询 4605出库单明细查询 4606出库单状态查询 4607库存查询 4608取消出库单 4609出库单状态及明细推送 4610入库单明细推送 4611出库单发票接口 |
| transMessageId | String(18) | 是 | 交易流水号格式如：YYYYMMDD+流水号{10},例如:201404120000000001 |
| code | String(3) | 是 | 响应状态码 |
| message | String(200) | 是 | 响应信息 |
| body | 否 | ||
| ...... | 根据交易类型和交易接口而定 |
响应状态码列表
1、 您可以从开放返回给您的错误代码中查找相应的状态码信息。
| 异常代码 | 异常信息 |
|---|---|
| EX_CODE_OPENAPI_0100 | 输入校验异常 |
| EX_CODE_OPENAPI_0101 | APPID 不存在 |
| EX_CODE_OPENAPI_0102 | APPKEY 不存在 |
| EX_CODE_OPENAPI_0103 | 访问令牌不存在 |
| EX_CODE_OPENAPI_0104 | 更新令牌不存在 |
| EX_CODE_OPENAPI_0105 | 访问令牌过期 |
| EX_CODE_OPENAPI_0106 | 更新令牌过期 |
| EX_CODE_OPENAPI_0200 | 操作成功 |
| EX_CODE_OPENAPI_0215 | 无此帐户信息异常 |
| EX_CODE_OPENAPI_0300 | 验证输入参数异常 |
| EX_CODE_OPENAPI_0400 | 操作失败 |
| EX_CODE_OPENAPI_0403 | 获取用户权限失败 |
| EX_CODE_OPENAPI_0404 | 重复下单 |
| EX_CODE_OPENAPI_0425 | 订单信息有误 |
| EX_CODE_OPENAPI_0444 | 查询路由信息不存在 |
| EX_CODE_OPENAPI_0445 | 该订单号非本系统的订单或者运单号不存在 |
| EX_CODE_OPENAPI_0446 | 该订单号尚未申请路由增量接口 |
| EX_CODE_OPENAPI_0500 | 系统异常 |