港区数据订阅 - 云当网数据接口

调用该接口前，需要先使用[获取Token API]获取token。token 有效期是2小时，超过了2小时得重新获取。

📌

港区数据支持范围

序号	港口名称	云当港口代码	备注
1	厦门港	CNXMN
2	上海港	CNSHA
3	宁波港	CNNGB
4	盐田港	CNYTN
5	蛇口港	CNSHK
6	大铲湾港	CNDCW
7	广州南沙港务码头	CNCAN
8	青岛港	CNTAO
9	天津港	CNTXG
10	大连港	CNDLC	需提供大连口岸物流网账号密码才可获取数据

请求参数

Query 参数

token

string

必需

示例值:

1382b465-f972-46da-a5b2-1d286fa84d96

companyid

string

必需

示例值:

1000

Body 参数multipart/form-data

data

string

必需

订阅参数，传的是JSON数据。
localkeyid:可以传贵司自定义的主键。
referenceno：港区提单/订舱号
ctnrno: 箱号
portcd：云当港口代码（必填）
ieid：进出口标识（I=进口，E=出口，必填）
type：类型（1=增强版，0=默认版）
*提单号/订舱号/箱号不可同时为空

示例值:

{"localkeyid":"5859f9a7-d0e8-428f-99f3-6e947169a005","referenceno":"COAU8036422250","portcd":"CNSHA","ieid":"E","ctnrno":"","type":""}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

success

boolean

是否订阅成功（Whether the subscription is successful）

必需

true=成功；false=失败(true=success;false=failed)

keyid

string

客户订阅主键（The customer subscribes to the primary key）

必需

订阅时上传的keyid（The keyid uploaded when subscribing）

referenceno

string

提单号/订舱号（BL NO. or BKG NO.）

必需

portcd

string

港口代码(Port code)

必需

ieid

string

进出口标识(Import and export identification)

必需

I=进口，E=出口( I=import, E=export)

message

string

错误信息(error message)

必需

ydkeyid

string

云当主键

必需

示例

{
    "keyid": "5859f9a7-d0e8-428f-99f3-6e947169a005",
    "referenceno": "COAU8036422250",
    "portcd": "CNSHA",
    "ieid": "E",
    "success": true,
    "message": "",
    "ydkeyid": "5859f9a7-d0e8-428f-99f3-6e947169a210"
}

⚪接口请求成功

⚪1接口请求失败