接口概述
接口概述
本接口规范用于外部供应商系统与VP系统的数据交互。主要采用http/https协议,使用post方式交互JSON数据。
测试根地址:http://vp-api-test.stbchina.cn/api
正式根地址:http://vp-api.stbchina.cn/api
除“获取token接口”外,其他的接口都需要在请求头里增加token。
请求头参数:Stb-Token**,**值为“获取token接口”取到的accessToken(见3.1)
请求参数类型的说明:
Path:指的是参数直接拼在API地址里,如API_URL/{pageNo}
Query:指的是参数跟在API地址后以参数形式体现,如API_URL?poNo={poNo}
Form:指的是Post请求下以Form参数的方式传入接口
Json:指的是Post请求下以Json格式的数据体传入接口
完整的例子:/api/v1/base/1?type=DIC_SKU_CLASS(基础数据获取接口)
其中:1是请求页码,Path类型的参数;type是数据类型,Query类型的参数
通用响应报文格式:
{
code: Integer,
message: String,
body: Object
}
code:响应码,200=正常响应,999=自定义错误,其他\=特定错误,见message
message:OK=正常,其他\=具体的错误信息
body:响应主体内容,若空则不输出