概述

平台需要与已有SAP业务打通和信息互通，对外提供相应API满足业务需求。围绕商品订单、库存、发货信息和发票核心业务提供接口。SAP通过调用平台提供的API，实现分销商主数据获取、订单获取、商品主数据回传、商品彩盒数据回传、发货单信息回传等业务场景。

调用说明

平台提供了RESTful（Representational State Transfer）风格API，支持您通过HTTPS请求调用。

1.1 如何使用

构造请求

介绍REST API请求的组成，如何调用API。

请求URL
请求URL由如下部分组成。
{URI-scheme} :// {Endpoint} / {resource-path} / {query-string}

URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。

Endpoint：指定承载REST服务端点的服务器域名或IP。

resource-path：资源路径，也即API访问路径。

query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“形式为参数取值。

请求头
附加请求头字段，如指定的URI和HTTP方法所要求的字段。

名称	类型	是否必选	说明
Content-Type	String	是	消息体的类型，取值“application/json;charset=utf-8”
token	String	登录后必填	登录成功后获取
sys	String	是	系统类型，取值“pp”
lang	String	是	语言类型，取值“en”
deviceType	Integer	是	客户端类型，取值“1”
uid	Integer	是	系统账号，取值“1”
traceId	String	是	请求id，每次请求生成一个uuid

请求方法
HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。

GET：请求服务器返回指定资源。

POST：请求服务器新增资源或执行特殊操作。

请求消息体
请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。
每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。

1.2 认证鉴权

API接口使用toekn方式认证。token认证就是在调用API的时候将token加到请求消息头，从而通过身份认证，获得操作API的权限。

1.3 返回结果

请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。

状态码
状态码是一组数字代码，状态码表示了请求响应的状态。

状态码	说明
0	成功
500	服务内部异常
501	服务不支持
503	服务不可用
504	远端服务超时
602	服务超时
1401	用户没有登录
1404	请求的资源不存在
1450	参数错误
2002	系统限流保护
2003	重复调用
2004	授权已过期
2005	授权已经过期，需要重新登录
2006	Token错误
3004	用户不存在
3015	密码不能为空
3016	用户状态未启用,不能进行登录操作
3017	用户名或密码不正确,请重新登录
3031	令牌验证失败
3032	令牌过期
3046	当前登录用户处于锁定状态,暂时不能登录
20005	文件格式错误

响应消息头
对应请求消息头，响应同样也有消息头，如“Content-type”等。

响应消息体
响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。

示例


{
    "code":10000, //操作状态码
    "msg":"OK", //操作描述
    "data":{} //操作返回数据，当data数据为空时，返回空对象“{}”
}

1.4 数据同步频率

SAP与分销商平台每30分钟同步一次数据。

1.5 域名

环境	域名
开发	https://dev-api.kresspartner.com
测试	https://test-api.kresspartner.com
预生产	美国：https://uat-api.kresspartner.com，欧洲：https://uat-euapi.kresspartner.com
生产	美国：https://usapi.kresspartner.com，欧洲：https://euapi.kresspartner.com

使用须知

概述#

调用说明#

1.1 如何使用#

构造请求#

1.2 认证鉴权#

1.3 返回结果#

1.4 数据同步频率#

1.5 域名#