开始

API 调用流程

海仓开放平台通过HTTP请求调用API，通过根据海仓开放平台协议将请求组合成一定的格式。本节介绍了如何组装HTTP请求来调用海仓api。

API调用需要数据作为输入，并返回输出作为响应。通过生成HTTP请求来调用API的一般步骤如下:

1. 填充参数和值
2. 组装HTTP请求
3. 发起HTTP请求
4. 获取HTTP响应
5. 解释JSON/XML响应

API 请求 URLs

生产环境

项目	URL
OMS	https://api-oms.seacang.com

沙箱环境

项目	URL
OMS	https://api-oms-sandbox.seacang.com

请求参数

请求头参数

参数名	类型	是否必填	说明
access_token	String	是	帐号授权令牌，通过业务员获取
user_code	String	是	当前帐号编号；如：SEA1001
timestamp	String	否	发送请求的时间戳

业务参数

除了必须包含在API调用请求中的请求头参数外，还需要请求的业务参数。有关每个API的业务参数的详细信息，请参阅API文档。

响应结果

返回内容

API 请求统一返回json结果

参数名	类型	是否必填	说明
code	int	是	状态码，0代表成功，其他表示请求异常
msg	String	否	返回内容描述
timestamp	String	否	发送时间戳
data	Object	否	业务数据

HTTP 请求示例

以获取商品库存(/inventory/get) API调用为例，组装HTTP请求的步骤如下:

填充参数和值

常见的参数:

user_code = " SEA1001 "
access_token = " test "
timestamp= " 1722322022500 "

业务参数:

good_code = " SEATH100001 "

构建HTTP请求

JAVA 代码示例

 
public static void demo() {
  Map<String, String> headers = new HashMap<>();
  headers.put("user_code", "SEA1001");
  headers.put("access_token", "test");
  headers.put("timestamp", "1722322022500");

  String url = "https://api-oms.seacang.com/inventory/get?good_code=SEATH100001";
  httpGet(url, headers);
}

public static String httpGet(String url, Map<String, String> headers) throws Exception {
  HttpGet httpGet = new HttpGet(url);
  for (Map.Entry<String, String> entry : headers.entrySet()) {
    httpGet.addHeader(entry.getKey(),entry.getValue());
  }
  CloseableHttpResponse response = httpClient.execute(httpGet);
  HttpEntity entity = response.getEntity();
  return EntityUtils.toString(entity,"UTF-8");
}

Postman 请求示例

Postman请求