# 数据API接口 V1.7.2
# 1. 概述
# 1.1 约定
| 约定 | 描述 |
|---|---|
| 编码方式 | UTF-8 |
| 返回数据格式 | JSON |
| 调用方式 | POST/GET;因GET请求有长度限制和特殊字符编码问题,建议使用POST |
# 1.2 请求地址
http://api.shipdt.com/DataApiServer/
# 1.3 授权码
调用接口时,需要传入授权码,
如:http://api.shipdt.com/DataApiServer/apicall/QueryShip?k=ea11553d6acb436fadae9c49ed8e150e&kw=cosco&max=3
# 2. 数据字典
# 2.1 错误码
| 状态值 | 描述 |
|---|---|
| 0 | 成功 |
| 1 | 失败,异常错误 |
| 3 | 操作对象不存在(船舶、船队等) |
| 6 | key过期 |
| 7 | key锁定 |
| 9 | key不存在 |
| 12 | 请求数据量过大,拒绝执行 |
| 13 | 服务器繁忙 |
| 15 | 多船请求数量超过限制 |
| 16 | 区域船舶接口超出区域外 |
| 17 | 区域船舶查询数量超限 |
| 19 | 程序内部错误 |
| 22 | 查询船舶数量超限 |
| 28 | 查询时间超限 |
| 29 | 没有查询到任何数据 |
| 30 | 气象区域查询超过限制 |
| 100 | 参数错误(缺少参数或参数不合法) |
| 101 | 区域提醒区域设置超过限制 |
| 102 | 档案查询结果数据集合大于2000条记录,需再精确查询条件 |
| 103 | MMSI无预测目的港 |
| 10000 | 网络连接失败 |
| 10001 | 不支持的操作 |
# 2.2 船舶AIS类型
| ID | 英文名称 | 中文名称 |
|---|---|---|
| 0 | Not available (default) | 不可用(默认) |
| 1-19 | Reserved for future use | 备用 |
| 20 | Wing in ground (WIG), all ships of this type | 地效翼船(WIG),全部 |
| 21 | Wing in ground (WIG), Hazardous category A | 地效翼船(WIG),A级 |
| 22 | Wing in ground (WIG), Hazardous category B | 地效翼船(WIG),B级 |
| 23 | Wing in ground (WIG), Hazardous category C | 地效翼船(WIG),C级 |
| 24 | Wing in ground (WIG), Hazardous category D | 地效翼船(WIG),D级 |
| 25 | Wing in ground (WIG), Reserved for future use | 地效翼船(WIG),备用 |
| 26 | Wing in ground (WIG), Reserved for future use | 地效翼船(WIG),备用 |
| 27 | Wing in ground (WIG), Reserved for future use | 地效翼船(WIG),备用 |
| 28 | Wing in ground (WIG), Reserved for future use | 地效翼船(WIG),备用 |
| 29 | Wing in ground (WIG), Reserved for future use | 地效翼船(WIG),备用 |
| 30 | Fishing | 渔船 |
| 31 | Towing | 工作船 |
| 32 | Towing: length exceeds 200m or breadth exceeds 25m | 工作船(船长>200m或船宽>25m) |
| 33 | Dredging or underwater ops | 从事疏浚或水下作业的船舶 |
| 34 | Diving ops | 潜水工作船 |
| 35 | Military ops | 军用船舶 |
| 36 | Sailing | 帆船 |
| 37 | Pleasure Craft | 游乐船 |
| 38 | Reserved | 已预留 |
| 39 | Reserved | 已预留 |
| 40 | High speed craft (HSC), all ships of this type | 高速船 (HSC),全部 |
| 41 | High speed craft (HSC), Hazardous category A | 高速船 (HSC),A级 |
| 42 | High speed craft (HSC), Hazardous category B | 高速船 (HSC),B级 |
| 43 | High speed craft (HSC), Hazardous category C | 高速船 (HSC),C级 |
| 44 | High speed craft (HSC), Hazardous category D | 高速船 (HSC),D级 |
| 45 | High speed craft (HSC), Reserved for future use | 高速船 (HSC),备用 |
| 46 | High speed craft (HSC), Reserved for future use | 高速船 (HSC),备用 |
| 47 | High speed craft (HSC), Reserved for future use | 高速船 (HSC),备用 |
| 48 | High speed craft (HSC), Reserved for future use | 高速船 (HSC),备用 |
| 49 | High speed craft (HSC), No additional information | 高速船 (HSC),备用 |
| 50 | Pilot Vessel | 引航船 |
| 51 | Search and Rescue vessel | 救助船 |
| 52 | Tug | 拖船 |
| 53 | Port Tender | 航标 |
| 54 | Anti-pollution equipment | 污染控制船 |
| 55 | Law Enforcement | 执法船 |
| 56 | Spare - Local Vessel | 备用-本地船只 |
| 57 | Spare - Local Vessel | 备用-本地船只 |
| 58 | Medical Transport | 医疗运输船 |
| 59 | Noncombatant ship according to RR Resolution No. 18 | 根据《无线电规则》第18号决议的非战斗舰 |
| 60 | Passenger, all ships of this type | 客船,全部 |
| 61 | Passenger, Hazardous category A | 客船,A级 |
| 62 | Passenger, Hazardous category B | 客船,B级 |
| 63 | Passenger, Hazardous category C | 客船,C级 |
| 64 | Passenger, Hazardous category D | 客船,D级 |
| 65 | Passenger, Reserved for future use | 客船,备用 |
| 66 | Passenger, Reserved for future use | 客船,备用 |
| 67 | Passenger, Reserved for future use | 客船,备用 |
| 68 | Passenger, Reserved for future use | 客船,备用 |
| 69 | Passenger, No additional information | 客船,备用 |
| 70 | Cargo, all ships of this type | 货船,全部 |
| 71 | Cargo, Hazardous category A | 货船,A级 |
| 72 | Cargo, Hazardous category B | 货船,B级 |
| 73 | Cargo, Hazardous category C | 货船,C级 |
| 74 | Cargo, Hazardous category D | 货船,D级 |
| 75 | Cargo, Reserved for future use | 货船,备用 |
| 76 | Cargo, Reserved for future use | 货船,备用 |
| 77 | Cargo, Reserved for future use | 货船,备用 |
| 78 | Cargo, Reserved for future use | 货船,备用 |
| 79 | Cargo, No additional information | 货船,备用 |
| 80 | Tanker, all ships of this type | 油船,全部 |
| 81 | Tanker, Hazardous category A | 油船,A级 |
| 82 | Tanker, Hazardous category B | 油船,B级 |
| 83 | Tanker, Hazardous category C | 油船,C级 |
| 84 | Tanker, Hazardous category D | 油船,D级 |
| 85 | Tanker, Reserved for future use | 油船,备用 |
| 86 | Tanker, Reserved for future use | 油船,备用 |
| 87 | Tanker, Reserved for future use | 油船,备用 |
| 88 | Tanker, Reserved for future use | 油船,备用 |
| 89 | Tanker, No additional information | 油船,备用 |
| 90 | Other Type, all ships of this type | 其他,全部 |
| 91 | Other Type, Hazardous category A | 其他,A级 |
| 92 | Other Type, Hazardous category B | 其他,B级 |
| 93 | Other Type, Hazardous category C | 其他,C级 |
| 94 | Other Type, Hazardous category D | 其他,D级 |
| 95 | Other Type, Reserved for future use | 其他,备用 |
| 96 | Other Type, Reserved for future use | 其他,备用 |
| 97 | Other Type, Reserved for future use | 其他,备用 |
| 98 | Other Type, Reserved for future use | 其他,备用 |
| 99 | Other Type, no additional information | 其他,备用 |
# 2.3 船舶档案船舶类型字典
| ID | 英文名称 | 中文名称 |
|---|---|---|
| 110100 | Cargo Ship | 货船 |
| 110200 | Bulk Carrier | 散货船 |
| 110300 | General Cargo Ship | 普通货船(杂货船) |
| 110400 | Ore Carrier | 矿砂船 |
| 110500 | Heavy Load Carrier | 重大件运输船 |
| 110600 | Ro-Ro Cargo Ship | 滚装货船 |
| 110700 | Cement Carrier | 水泥运输船 |
| 110800 | Livestock Carrier | 牲畜运输船 |
| 110900 | Ore/Oil Carrier | 矿/油船 |
| 111100 | Other Cargos | 其他货船 |
| 120100 | Container Ship | 集装箱船 |
| 120200 | Passenger/Container Ship | 集装箱/客船 |
| 130100 | Tanker | 油船 |
| 130200 | Chemical Tanker | 化学品船 |
| 130300 | Chemical/Oil Products Tanker | 成品油化船 |
| 130400 | Crude Oil Tanker | 原油船 |
| 130500 | Oil Products Tanker | 成品油船 |
| 130600 | LNG Tanker | LNG |
| 130700 | LPG Tanker | LPG |
| 130800 | Bunkering Tanker | 加油船 |
| 130900 | Water Tanker | 运水船 |
| 131100 | Other Tankers | 其他液货船 |
| 140100 | Tug | 拖船 |
| 140200 | Pusher Tug | 顶推拖轮 |
| 140300 | Dredger | 挖泥船 |
| 140400 | Crane Ship | 起重船 |
| 140500 | Patrol Vessel | 巡逻船 |
| 140600 | Cable-Layer | 电缆船 |
| 140700 | Research Vessel | 科考船 |
| 140800 | Other Service Ships | 其他服务船 |
| 150100 | Fishing Vessel | 渔船 |
| 150200 | Fish Carrier | 运鱼船 |
| 150300 | Other Fishing | 其他渔船 |
| 160100 | Passenger (Cruise) Ship | 邮轮 |
| 160200 | Passenger Ship | 客船 |
| 160300 | Passenger/Landing Craft | 登陆船/客船 |
| 160400 | Passenger/Ro-Ro Cargo Ship | 滚装/客船 |
| 170100 | High speed craft (HSC) | 高速船 (HSC) |
| 180100 | Port Tender | 航标 |
| 180200 | Buoy/Lighthouse Vessel | 浮标/灯塔船 |
| 190100 | Others Vessels | 其他 |
| 190200 | Pleasure Craft | 娱乐船 |
| 190300 | Pilot Vessel | 引航船 |
| 190400 | Sailing Vessel | 帆船 |
| 190500 | Wing in ground (WIG) | 地效翼船 |
| 190600 | Offshore Vessels | 海工船 |
# 2.4 船舶航行状态
| 状态 | 描述 |
|---|---|
| 0 | 在航(主机推动) |
| 1 | 锚泊 |
| 2 | 失控 |
| 3 | 操纵受限 |
| 4 | 吃水受限 |
| 5 | 靠泊 |
| 6 | 搁浅 |
| 7 | 从事捕鱼 |
| 8 | 靠船帆提供动力 |
| 9 | 保留将来修订之用 |
| 10 | 保留将来修订之用 |
| 11 | 预留供将来使用 |
| 12 | 预留供将来使用 |
| 13 | 预留供将来使用 |
| 14 | AIS-SART |
| 15 | 未定义 |
# 2.5 降水强度
| 范围值 | 等级 |
|---|---|
| 0.03~0.25 | 小雨(雪) |
| 0.25~0.35 | 中雨(雪) |
| 0.35~0.48 | 大雨(雪) |
| >0.48 | 暴雨(雪) |
# 2.6 天气状况
| 代码 | 天气描述 |
|---|---|
| CLEAR_DAY | 晴(白天) |
| CLEAR_NIGHT | 晴(夜间) |
| PARTLY_CLOUDY_DAY | 多云(白天) |
| PARTLY_CLOUDY_NIGHT | 多云(夜间) |
| CLOUDY | 阴 |
| WIND | 大风 |
| HAZE | 雾霾 |
| RAIN | 雨 |
| SNOW | 雪 |
# 3. 船舶数据接口
# 3.1 船舶搜索
船舶搜索是通过已知的船舶某些参数,来获取船舶ShipId的数据接口。
用户可以通过船名、呼号、MMSI、IMO等条件,获取到船舶在船达通系统中的唯一ID;接口只返回船名、呼号、MMSI(ShipID)、IMO等船舶的静态信息,用户可通过ShipId调用其它接口获取船舶详细信息。
# 3.1.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/QueryShip?k=key&kw=cosco&max=10
# 3.1.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| kw | 关键字 | 是 | 船名、呼号、MMSI、IMO | |
| max | 最大返回数 | 否 | 100 | 1-100 |
# 3.1.3 返回结果示例
{
"status":0,
"data":[{
"ShipID":477189000,
"MatchType":2,
"mmsi":477189000,
"shiptype":47,
"name":"COSCO SCORPIO",
"callsign":"VRRV5X",
"imo":9789635,
"lasttime":1530679012
}]
}
# 3.1.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| data | JsonArray | 结果集 | |
| ShipId | long | 船舶主键 | |
| MatchType | int | 匹配类型 | 1:船名 \n 2:呼号 \n 3:mmsi \n 5:imo |
| mmsi | long | MMSI | |
| shiptype | int | 船舶AIS类型 | 参考2.2船舶类型字典 |
| name | string | 船舶名称 | |
| callsign | string | 呼号 | |
| imo | int | IMO | |
| lasttime | long | 最新船位时间 | 时间戳 秒 |
# 3.2 单船查询
根据船舶主键查询船舶详情
# 3.2.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/GetSingleVesselShip?k=key&id=414096000
# 3.2.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| id | 船舶主键 | 是 |
# 3.2.3 返回结果示例
{
"status":0,
"data":[{
"ShipID":414096000,
"mmsi":414096000,
"imo":9584803,
"name":"BO HAI CUI ZHU",
"callsign":"BBGK",
"shiptype":60,
"length":1780,
"width":280,
"left":10,
"trail":1510,
"draught":6800,
"dest":"YANTAIDALIAN",
"dest_std":"Yantai,CN",
"destcode":"CNYTG",
"eta":"07-28 18:30",
"eta_std":"2020-07-28 18:30:00",
"navistat":5,
"lat":37554211,
"lon":121377251,
"hdg":12200,
"cog":30950,
"sog":0,
"rot":0,
"lasttime":1596096681
}]
}
# 3.2.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| data | JsonArray | 结果集 | 只有一条数据 |
| ShipID | long | 船舶主键 | |
| mmsi | long | mmsi | |
| imo | int | IMO | 0表示不可用 默认值 |
| callsign | string | 呼号 | |
| shiptype | int | 船舶类型 | 参考2.2船舶类型字典 |
| length | int | 船长 | 单位:分米 |
| width | int | 船宽 | 单位:分米 |
| left | int | ais设备距左弦距离 | 单位:分米 |
| trail | int | ais设备距船尾距离 | 单位:分米 |
| draught | int | 吃水 | 单位:毫米 |
| dest | string | 目的地 | |
| dest_std | string | 根据dest匹配船达通的港口库 | |
| destcode | string | 根据dest匹配船达通的港口库后的港口编码 | |
| eta | string | 预到时间 | 格式:MM-dd HH:mm |
| eta_std | string | 标准化后的预到时间 | 格式:yyyy-MM-dd HH:mm:ss |
| navistat | int | 船舶航行状态 | 参考2.3船舶航行状态字典 |
| lat | long | 纬度 | 1/1000000度 |
| lon | long | 经度 | 1/1000000度 |
| hdg | int | 船艏向 | 1/100度,正北为0 |
| cog | int | 航迹向 | 1/100度,正北为0 |
| sog | int | 航速 | 单位:毫米/秒 |
| rot | int | 转向率 | 1/100度,单位:度/秒,[-1200, 1200] |
| lasttime | long | 最新船位时间 | 时间戳 秒 |
# 3.3 多船查询
一次请求多条船舶数据,单次不得超过500艘。
# 3.3.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/GetManyShip?k=key&id=477765900,414096000
# 3.3.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| id | 船舶主键 | 是 | 多条船舶以","分隔符分隔开 |
# 3.3.3 返回结果示例
同3.2.3
# 3.3.4 返回字段说明
同3.2.4
# 3.4 区域船舶查询
区域船舶是按照区域范围,一次请求该区域内的所有船舶,单次范围不得超过2°*2°;
由于部分区域内的船舶数量极多,若区域查询的船舶总数超过2800艘,不返回数据,只返回船舶数量。
# 3.4.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/GetAreaShip?&k=key&minlon=122419530&maxlon=122663475&minlat=31777556&maxlat=31848200&hour=1
# 3.4.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| minlon | 最小经度 | 是 | 乘以1000000 | |
| maxlong | 最大经度 | 是 | 乘以1000000 | |
| minlat | 最小纬度 | 是 | 乘以1000000 | |
| maxlat | 最大纬度 | 是 | 乘以1000000 |
# 3.4.3 返回结果示例
{
"status":0,
"shipcount":1,
"data":[{
"ShipID":412411726,
"mmsi":412411726,
"imo":0,
"name":"ZHEJIAOYU92006",
"callsign":"92006",
"shiptype":30,
"length":110,
"width":20,
"left":0,
"trail":0,
"draught":0,
"dest":"",
"dest_std":"",
"destcode":"",
"eta":"",
"eta_std":"",
"navistat":0,
"lat":28732335,
"lon":121677166,
"hdg":8700,
"cog":8720,
"sog":823,
"rot":0,
"lasttime":1596161205
}]
}
# 3.4.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| shipcount | int | 船舶数量 | |
| data | JsonArray | 结果集 | |
| ShipID | long | 船舶主键 | |
| mmsi | long | mmsi | |
| imo | int | IMO | 0表示不可用 默认值 |
| callsign | string | 呼号 | |
| shiptype | int | 船舶类型 | 参考2.2船舶类型字典 |
| length | int | 船长 | 单位:分米 |
| width | int | 船宽 | 单位:分米 |
| left | int | ais设备距左弦距离 | 单位:分米 |
| trail | int | ais设备距船尾距离 | 单位:分米 |
| draught | int | 吃水 | 单位:毫米 |
| dest | string | 目的地 | |
| dest_std | string | 根据dest匹配船达通的港口库 | |
| destcode | string | 根据dest匹配船达通的港口库后的港口编码 | |
| eta | string | 预到时间 | 格式:MM-dd HH:mm |
| eta_std | string | 标准化后的预到时间 | 格式:yyyy-MM-dd HH:mm:ss |
| navistat | int | 船舶航行状态 | 参考2.3船舶航行状态字典 |
| lat | long | 纬度 | 1/1000000度 |
| lon | long | 经度 | 1/1000000度 |
| hdg | int | 船艏向 | 1/100度,正北为0 |
| cog | int | 航迹向 | 1/100度,正北为0 |
| sog | int | 航速 | 单位:毫米/秒 |
| rot | int | 转向率 | 1/100度,单位:度/秒,[-1200, 1200] |
| lasttime | long | 最新船位时间 | 时间戳 秒 |
备注:返回结果多shipcount属性之外,其它同3.2
# 3.5 船舶抽稀轨迹查询
根据船舶主键查询船舶一段时间的轨迹,最多只能查询30天轨迹;
单次返回轨迹有数量限制,超出数量后根据当前查询结果的最后一个点作为开始时间,继续查询后续的数据。
# 3.5.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/GetShipVesselTrack?k=key&id=412473010&btm=1393516800&etm=1394165100
# 3.5.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| id | 船舶主键 | 是 | ||
| btm | 开始时间 | 是 | 时间戳 秒 | |
| etm | 结束时间 | 是 | 时间戳 秒 |
# 3.5.3 返回结果示例
{
"status":0,
"continue":"1",
"points": [{
"utc":1594910516,
"lat":38974366,
"lon":118068016,
"cog":6500,
"sog":51
}]
}
# 3.5.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| continue | string | 是否后数据未返回 | "1":有;"0":没有 |
| points | JsonArray | 结果集 | |
| utc | long | 时间戳 | |
| lat | long | 纬度 | 1/1000000 度 |
| lon | long | 经度 | 1/1000000 度 |
| cog | int | 航迹向 | 1/100 度 |
| sog | int | 速度 | 毫米/秒 |
# 3.6 船舶全量轨迹查询
同3.5类似,但返回的轨迹没有做抽稀处理,次接口返回的数据量可能会非常大。
# 3.6.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/GetShipAllVesselTrack?k=key&id=412473010&btm=1393516800&etm=1394165100
# 3.6.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| id | 船舶主键 | 是 | ||
| btm | 开始时间 | 是 | 时间戳 秒 | |
| etm | 结束时间 | 是 | 时间戳 秒 |
# 3.6.3 返回结果示例
# 3.6.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| continue | string | 是否后数据未返回 | "1":有;"0":没有 |
| points | JsonArray | 结果集 | |
| utc | long | 时间戳 | |
| lat | long | 纬度 | 1/1000000 度 |
| lon | long | 经度 | 1/1000000 度 |
| cog | int | 航迹向 | 1/100 度 |
| sog | int | 速度 | 毫米/秒 |
# 3.7 船舶档案查询
通过船名、呼号、MMSI、IMO 等条件查询船舶档案;
搜索为模糊检索,返回结果是数组。
# 3.7.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/SearchShipParticular?k=key&mmsi=477947600&imo=9484297&shipname=COSCODURBAN&callsign=VRKR5
# 3.7.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| mmsi | 船舶主键 | 否 | ||
| imo | IMO | 否 | ||
| shipname | 船舶名称 | 否 | ||
| callsign | 呼号 | 否 |
注:mmsi、IMO、船名、呼号至少有一个不为空
# 3.7.3 返回结果示例
{
"status":"0",
"result": [{
"mmsi":"477947600",
"imo":"9484297",
"name_ch":"",
"name_en":"COSCODURBAN",
"ship_type":"",
"callsign":"VRKR5",
"flag_name":"中国香港",
"home_port":"",
"length":"261.04",
"breadth":"32.25",
"depth":"19.3",
"avg_draft":"",
"fully_loaded":"",
"gt":"40447",
"nt":"23713",
"dwt":"50006",
"carport":"",
"pass_spa":"",
"ship_container_num":"4253",
"builder":"",
"builder_en":"Jiangsu New YZJ",
"date_built":"2012/06/01",
"ship_built_addr_cn":"",
"ship_built_addr_en":"",
"ismmanager":"SHANGHAI OCEAN SHIPPING CO LTD",
"ismaddress":"COSCO PLAZA, 378, DONGDAMING LU, HONGKOU QU, SHANGHAI, 200080, CHINA.",
"ismdataofeffect":"SINCE 20/06/2012",
"shipowner_en":"CHINA COSCO SHIPPING",
"shipowner_ch":"",
"owner_legal_person":"",
"fox":"",
"call":"",
"call_night":"",
"owneraddress_en":"CARE OF COSCO SHIPPING LINES CO LTD , COSCO PLAZA, 378, DONGDAMING LU, HONGKOU QU, SHANGHAI, 200080, CHINA.",
"owneraddress_ch":"",
"ownerdataofeffect":"SINCE 18/06/2012",
"shipmanager_en":"COSCO PLAZA, 378, DONGDAMING LU, HONGKOU QU, SHANGHAI, 200080, CHINA.",
"shipmanager_ch":"",
"shipmanageraddress_ch":"",
"shipmanageraddress_en":"COSCO PLAZA, 378, DONGDAMING LU, HONGKOU QU, SHANGHAI, 200080, CHINA.",
"shipmanagerdataofeffect":"SINCE 18/06/2012"
}]
}
# 3.7.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| result | JsonArray | 结果集 | |
| mmsi | string | 船舶mmsi | |
| imo | string | IMO | |
| name_ch | string | 中文名称 | |
| name_en | string | 英文名称 | |
| ship_type | string | 船舶类型 | |
| callsign | string | 呼号 | |
| flag_name | string | 船旗 | |
| home_port | string | 船籍港 | |
| length | string | 船长 | 单位:米 |
| breadth | string | 船宽 | 单位:米 |
| depth | string | 船深 | 单位:米 |
| avg_draft | string | 平均吃水 | 单位:米 |
| fully_loaded | string | 满载吃水 | 单位:米 |
| gt | string | 总吨 | 单位:吨 |
| nt | string | 净吨 | 单位:吨 |
| dwt | string | 载重吨 | 单位:吨 |
| carport | string | 车位数 | |
| pass_spa | string | 客位数 | |
| ship_container_num | string | 箱量 | |
| builder | string | 船厂中文名 | |
| builder_en | string | 船厂英文名 | |
| date_built | string | 造船日期 | |
| ship_built_addr_cn | string | 中文建造地址 | |
| ship_built_addr_en | string | 英文建造地址 | |
| ismmanager | string | ISM | |
| ismaddress | string | ISM建造地址 | |
| ismdataofeffect | string | ISM生效日期 | |
| shipowner_en | string | 英文船舶所有人 | |
| shipowner_ch | string | 中文船舶所有人 | |
| owner_legal_person | string | 法人 | |
| fox | string | 传真 | |
| call | string | 联系方式 | |
| call_night | string | ||
| owneraddress_en | string | 英文船舶所有人地址 | |
| owneraddress_ch | string | 中文船舶所有人地址 | |
| ownerdataofeffect | string | 所有人生效日期 | |
| shipmanager_en | string | 英文船舶管理人名称 | |
| shipmanager_ch | string | 中文船舶管理人名称 | |
| shipmanageraddress_ch | string | 中文船舶管理人地址 | |
| shipmanageraddress_en | string | 英文船舶管理人地址 | |
| shipmanagerdataofeffect | string | 船舶管理人生效日期 |
# 3.8 船舶档案查询 - 新
# 3.8.1 请求地址
http://api.shipdt.com/DataApiServer/dataapi/vesselInfo/getShipVesselInfo?k=70e64ea11e&shipname=COSCODURBAN
# 3.8.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| mmsi | 船舶主键 | 否 | ||
| imo | IMO | 否 | ||
| shipname | 船舶名称 | 否 | ||
| callsign | 呼号 | 否 |
注:mmsi、imo、shipname、callsign 至少有一个不为空
# 3.8.3 返回结果示例
{
"status": 0,
"message": null,
"result": [
{
"shipId": 477947600,
"vesselNameEn": "COSCO DURBAN",
"vesselNameCn": "COSCO DURBAN",
"flag": "HKG",
"imo": "9484297",
"mmsi": 477947600,
"callsign": "VRKR5",
"aisVesselTypeLv2": 71,
"length": 26104,
"width": 3225,
"dwt": 50006,
"built": "2012",
"gt": 40447,
"nt": null,
"lvesselTypeLv3": 120101,
"lvesselTypeLv1": 120000,
"shipType": 120100
},
{
"shipId": 477947637,
"vesselNameEn": "COSCO DURBAN H",
"vesselNameCn": "COSCO DURBAN H",
"flag": "HKG",
"imo": "",
"mmsi": 477947637,
"callsign": "VRKR5",
"aisVesselTypeLv2": 70,
"length": 26100,
"width": 3200,
"dwt": null,
"built": null,
"gt": null,
"nt": null,
"lvesselTypeLv3": 110100,
"lvesselTypeLv1": 110000,
"shipType": 110100
}
]
}
# 3.8.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| result | JsonArray | 结果集 | |
| shipId | string | 船舶mmsi | |
| callsign | string | 呼号 | |
| imo | int | IMO | |
| vesselNameEn | string | 英文船舶名称 | |
| vesselNameCn | string | 中文船舶名称 | |
| flag | string | 国旗 | |
| mmsi | int | 船舶唯一标识mmsi | |
| length | int | 船舶长度 | |
| width | int | 船舶宽度 | |
| dwt | int | 装载吨 | |
| built | string | 建造时间 | |
| gt | string | 总吨 | |
| nt | string | 净吨 | |
| shipType | string | 船舶类型 | |
| aisVesselTypeLv2 | int | ais船舶类型 |
# 4 船舶挂靠记录查询
# 4.1 船舶靠港记录
根据时间段查询船舶的靠港记录;
最长可查询一年记录。
# 4.1.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/GetPortOfCallByShip?k=key&mmsi=477947600&imo=9484297&shipname=&callsign=&begin=1593792000&end=1595433600
# 4.1.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| mmsi | 船舶主键 | 否 | ||
| imo | IMO | 否 | ||
| shipname | 船舶名称 | 否 | ||
| callsign | 呼号 | 否 | ||
| begin | 开始时间 | 是 | 时间戳:秒 | |
| end | 结束时间 | 是 | 时间戳:秒 |
注:
mmsi、IMO、船名、呼号至少有一个不为空;
模糊匹配,尽量传入精确的参数,否则可能返回多条船舶挂靠记录。
# 4.1.3 返回结果示例
{
"status":"0",
"records":[{
"shipname":"COSCO DURBAN",
"callsign":"VRKR5",
"imo":9484297,
"shiptype_cn":"集装箱船",
"shiptype_en":"Container",
"mmsi":477947600,
"portname_cn":"",
"portname_en":"BUSAN NEW PORT",
"porttimezone":"9",
"portcode":"KRBNP",
"country_cn":"韩国",
"country_en":"Korea",
"countrycode":"KR",
"ata":"2020-07-19 23:11:21",
"atd":"2020-07-20 11:55:50",
"stayinport":"12.7"
}]
}
# 4.1.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| records | JsonArray | 结果集 | |
| shipname | string | 船舶名称 | |
| callsign | string | 呼号 | |
| imo | int | IMO | |
| shiptype_cn | string | 中文船舶类型名称 | |
| shiptype_en | string | 英文船舶类型 | |
| mmsi | long | 船舶主键 | |
| portname_cn | string | 港口中文名称 | |
| portname_en | string | 港口英文名称 | |
| porttimezone | string | 港口时区 | |
| portcode | string | 港口五位码 | |
| country_cn | string | 中文国家名称 | |
| country_en | string | 英文国家名称 | |
| countrycode | string | 国家两位码 | |
| ata | string | 实际到港时间(北京时间) yyyy-MM-dd HH:mm:ss | |
| atd | string | 实际离港时间(北京时间) yyyy-MM-dd HH:mm:ss | |
| stayinport | string | 在港口停留时间 单位:小时 |
# 4.2 港口挂靠历史
根据港口和时间查询这个港口所有船舶的挂靠记录;
一次最多查7天数据,不限时间段。
# 4.2.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/GetPortOfCallByPort?k=key&portid=1&begin=1596124800&end=1596384000
# 4.2.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| portid | 港口id | 是 | ||
| begin | 开始时间 | 是 | 时间戳 秒 | |
| end | 结束时间 | 是 | 时间戳 秒 |
# 4.2.3 返回结果示例
{
"status":"0",
"records": [{
"shipname":"NAEBA GALAXY",
"callsign":"9V5147",
"imo":9791169,
"mmsi":563054800,
"shiptype_cn":"油船",
"shiptype_en":"Tanker",
"currentport": {
"portid":"1",
"portname_cn":"安平港",
"portname_en":"Anping",
"porttimezone":"8",
"ata":"",
"atd":"2020-08-01 07:19:06",
"stayinport":""
}
}]
}
# 4.2.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| records | JsonArray | 结果集 | |
| shipname | string | 船舶名称 | |
| callsign | string | 呼号 | |
| imo | int | IMO | |
| mmsi | long | 船舶主键 | |
| shiptype_cn | string | 中文船舶类型 | |
| shiptype_en | string | 英文船舶类型 | |
| currentport | JsonObj | 停靠数据 | |
| portid | string | 港口id | |
| portname_cn | string | 港口中文名称 | |
| portname_en | string | 港口英文名称 | |
| porttimezone | string | 港口时区 | |
| ata | string | 实际到港时间(北京时间) yyyy-MM-dd HH:mm:ss | |
| atd | string | 实际离港时间(北京时间)yyyy-MM-dd HH:mm:ss | |
| stayinport | string | 实际在港停留时长 单位:小时 |
# 4.3 船舶挂靠指定港口查询
通过船舶及港口查询船舶挂此港口的历史靠港记录。可以查询挂靠单个港口的记录,也可以查询挂靠多个港口的记录。
用户可以通过船名、呼号、MMSI、IMO 等条件查询历史靠港记录
# 4.3.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/GetPortOfCallByShipPort?k=key&mmsi=563054800&portid=1&begin=1596124800&end=1596384000
# 4.3.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| mmsi | 船舶主键 | 否 | ||
| imo | IMO | 否 | ||
| shipname | 船舶名称 | 否 | ||
| callsign | 呼号 | 否 | ||
| portid | 港口id | 是 | ||
| begin | 开始时间 | 是 | 时间戳 秒 | |
| end | 结束时间 | 是 | 时间戳 秒 |
备注:
1)按照船名查询,空格可有可无,字母可大写可小写,但字母数字顺序和个数必须与查询的船名一致,如果不同船舶的名称相同,则同名船舶的靠港记录都将返回;
2)mmsi、IMO、shipname、callsign至少传一个且不能同时传多个
# 4.3.3 返回结果示例
{
"status":"0",
"records":[{
"shipname":"NAEBA GALAXY",
"callsign":"9V5147",
"imo":9791169,
"shiptype_cn":"油船",
"shiptype_en":"Tanker",
"mmsi":563054800,
"portname_cn":"安平港",
"portname_en":"Anping",
"porttimezone":"8",
"portcode":"CNAPG",
"country_cn":"中国",
"country_en":"China",
"countrycode":"CN",
"ata":"2020-07-30 13:13:56",
"atd":"2020-08-01 07:19:06",
"stayinport":"42.1"
}]
}
# 4.3.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| records | JsonArray | 结果集 | |
| shipname | string | 船舶名称 | |
| callsign | string | 呼号 | |
| imo | int | IMO | |
| shiptype_cn | string | 中文船舶类型 | |
| shiptype_en | string | 英文船舶类型 | |
| mmsi | long | 船舶主键 | |
| protname_cn | string | 中文港口名称 | |
| portname_en | string | 英文港口名称 | |
| porttimezone | string | 港口时区 | |
| portcode | string | 港口五位码 | |
| country_cn | string | 中文国家名称 | |
| country_en | string | 英文国家名称 | |
| ata | string | 实际到港时间(北京时间) yyyy-MM-dd HH:mm:ss | |
| atd | string | 实际离港时间(北京时间)yyyy-MM-dd HH:mm:ss | |
| stayinport | string | 实际在港停留时长 单位:小时 |
# 4.4 船舶挂靠当前状态
通过船舶已知参数查询船舶的当前挂靠状态,包括上一港口的挂靠信息及当前港口的挂靠信息;
用户可以通过船名、呼号、MMSI、IMO 等条件查询船舶挂靠当前状态。
# 4.4.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/GetShipStatus?k=key&mmsi=412330020
# 4.4.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| mmsi | 船舶主键 | 是 |
备注:
1)按照船名查询,空格可有可无,字母可大写可小写,但字母数字顺序和个数必须与查询的船名一致,如果不同船舶的名称相同,则同名船舶的靠港记录都将返回;
2)mmsi、IMO、shipname、callsign至少传一个且不能同时传多个
# 4.4.3 返回结果示例
{
"status": "0",
"records": [{
"shipname": "BO HAI BAO ZHU",
"callsign": "BBJE",
"imo": 0,
"shiptype_cn": "客船",
"shiptype_en": "Passenger",
"mmsi": 412330020,
"previousport": [{
"portname_en": "LANSHAN",
"portname_cn": "日照 岚山港",
"portid": 32,
"porttimezone": 8,
"portcode": "CNLSN",
"country_cn": "中国",
"country_en": "China",
"countrycode": "CN",
"ata": "2020-07-26 02:02:16",
"atd": "2020-07-26 10:00:20",
"stayinport": "8.0"
}],
"currentport": [{
"portname_en": "Zhifu Bay",
"portname_cn": "烟台, 芝罘湾港区",
"portid": 7950,
"porttimezone": 8,
"portcode": "",
"country_cn": "中国",
"country_en": "China",
"countrycode": "CN",
"ata": "2020-07-27 14:35:07"
}]
}]
}
# 4.4.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| records | JsonArray | 结果集 | |
| shipname | string | 船舶名称 | |
| callsign | string | 呼号 | |
| imo | int | IMO | |
| shiptype_cn | string | 中文船舶类型 | |
| shiptype_en | string | 英文船舶类型 | |
| mmsi | long | 船舶主键 | |
| previousport | JsonObj | 出发港信息 | |
| currentport | JsonObj | 目的港信息 | |
| portname_en | string | 英文港口名称 | |
| portname_ch | string | 中文港口名称 | |
| portid | int | 港口ID | |
| porttimezone | int | 港口时区 | |
| portcode | String | 港口五位码 | |
| country_cn | string | 中文国家名称 | |
| country_en | string | 英文国家名称 | |
| countrycode | string | 国家编码 | |
| ata | string | 实际到港时间(北京时间),时间戳 秒 | |
| atd | string | 实际离港时间(北京时间),时间戳 秒 | |
| stayinport | string | 港口停留时长 单位:小时 |
# 5 船舶推送服务
# 5.1 推送船舶列表设置
每次调用将全量更新船舶列表,用于以下事件推送:
1) 船舶到港事件推送
2) 船舶离港事件推送
3) 船位信息推送
4) 动态ETA推送
5) 区域提醒推送
# 5.1.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/UpdateShips?k=key&mmsi=477765900,414096000
# 5.1.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| mmsi | 船舶主键 | 是 | 多条船以","隔开 |
# 5.1.3 返回结果示例
{
"status": 0
}
# 5.1.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 |
# 5.2 区域提醒区域设置
如若用户要使用,需先设置区域提醒的范围。
每个区域的范围不能大于200平方海里,根据区域名称来判断是否是相同区域;如果当前区域名以前设置区域,再次调用该接口时,会根据区域名对区域范围进行修改,否则则新增该区域。
用户最多能设置5个不同区域。
# 5.2.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/UpdateArea?k=key&minlon=122419530&maxlon=122663475&minlat=31777556&maxlat=31848200&areaname=1
# 5.2.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| minlon | 最小经度 | 是 | 乘以1000000 | |
| maxlon | 最大经度 | 是 | 乘以1000000 | |
| minlat | 最小纬度 | 是 | 乘以1000000 | |
| maxlat | 最大纬度 | 是 | 乘以1000000 | |
| areaname | 区域名称 | 是 |
# 5.2.3 返回结果示例
{
"status": 0
}
# 5.2.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 |
# 5.3 推送回调地址设置
设置事件回调地址
# 5.3.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/SetCallBackUrl?k=key&url=http://push.test.com/ReceiveEvent&type=1
# 5.3.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| url | 回调地址 | 是 | 地址包含特殊字符,需要进行URLEncode | |
| type | 类型 | 是 | 1:船舶到离港事件回调地址 \n2:船位推送事件回调地址 \n3:动态ETA推送回调地址 \n4:区域提醒推送回调地址 \n11:区域数据推送地址 |
# 5.3.3 返回结果示例
{
"status": 0
}
# 5.3.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 |
# 5.4 船舶到离港时间推送数据说明
# 5.4.1 推送说明
时间类型包括:到达港口、完成靠泊、离开港口。
# 5.4.2 推送数据示例
{
"shipname": "DAMPIER MARU",
"callsign": "3FCV7",
"imo": 9479254,
"mmsi": 373421000,
"eventtype": 2,
"eventtime": "2018-12-26 11:20",
"eventtime_utc": "2018-12-26 19:20:56",
"portname_en": "DAMPIER",
"porttime_zone": 8,
"terminal_name": "",
"country_en": "Australia",
"portname_cn": "丹皮尔",
"portcode": "AUDAM"
}
# 5.4.3 推送字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| shipname | string | 船名名称 | |
| callsign | string | 呼号 | |
| imo | int | IMO | |
| mmsi | long | 船舶MMSI | |
| eventtype | int | 事件类型 | 1:ATA(到达港口)2:ATB(完成靠泊)3:ATD(离开港口) |
| eventtime | string | 发生事件的时间 | +0 yyyy-MM-dd HH:mm |
| eventtime_utc | string | 发生事件的时间 | +8 yyyy-MM-dd HH:mm |
| portname_en | string | 港口英文名称 | |
| porttime_zone | int | 港口所在的时区 | |
| terminal_name | string | 码头英文名称 | |
| country_en | string | 港口所属国家或地区因为名称 | |
| portname_cn | string | 港口中文名称 | |
| portcode | string | 港口五位码 |
# 5.5 船位信息推送数据说明
# 5.5.1 推送说明
每10分钟向用户推送船舶最新位置及其他动静态信息。
# 5.5.2 推送数据示例
{
"status": 0,
"data": [{
"ShipID": 205250000,
"mmsi": 205250000,
"shiptype": 70,
"imo": 9508392,
"name": "MINERAL DRAGON",
"callsign": "ONFN",
"length": 2920,
"width": 450,
"left": 240,
"trail": 410,
"draught": 18000,
"dest": "FU QING",
"dest_std": "GANGAVARAM,IN",
"destcode": "CNGZH",
"eta": "12-22 10:00",
"eta_std": "2017-11-22 10:00:00",
"navistat":5,
"lat": 17000000,
"lon": 83000000,
"sog": 154,
"cog": 611,
"hdg": 4700,
"rot": 0,
"lasttime": 1545669760
}]
}
# 5.5.3 推送字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态码 | |
| data | JsonArr | Json数组 | |
| ShipID | long | 船舶ID | |
| mmsi | long | 船舶MMSI | |
| shiptype | int | 船舶类型 | |
| imo | int | 船舶IMO号 | |
| name | string | 船舶名称 | |
| callsign | string | 船舶呼号 | |
| length | int | 船舶长度 | 单位:分米 |
| width | int | 船舶宽度 | 单位:分米 |
| left | int | 左舷距 | 单位:分米 |
| trail | int | 尾距 | 单位:分米 |
| draught | int | 吃水 | 单位:毫米 |
| dest | string | 目的地 | |
| dest_std | string | 标准化目的地 | |
| destcode | string | 目的地代码 | |
| eta | string | 船舶预到时间 | |
| eta_std | string | 标准化后的预到时间 | |
| navistat | int | 船舶航行状态 | |
| lat | long | 纬度 | 纬度*1000000 |
| lon | long | 经度 | 经度*1000000 |
| sog | int | 速度 | 毫米/秒 |
| cog | int | 航迹向 | 航迹向*100 |
| hdg | int | 船艏向 | 船艏向*100 |
| rot | int | 转向率 | 转向率*100/度/秒 |
| lasttime | long | 更新时间 |
# 5.6 ETA推送数据说明
# 5.6.1 推送说明
每10分钟推送船舶eta和目的地。
# 5.6.2 推送数据示例
{
"status": 0,
"data": [{
"mmsi": 205549000,
"shipname": "MINERAL DALIAN",
"imo": 9474137,
"callsign": "ONFW",
"portname": "VLADIVOSTOK,RU",
"portcode": "RUVVO",
"eta": "2018-12-28 14:00:00",
"porttimezone": "9"
}]
}
# 5.6.3 推送字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态码 | |
| data | JsonArr | Json数组 | |
| mmsi | long | 船舶MMSI | |
| shipname | string | 船舶名称 | |
| imo | int | IMO | |
| callsign | string | 船舶呼号 | |
| portname | string | 预抵港口名称 | |
| portcode | string | 港口五位码 | |
| eta | string | 预到时间 | |
| porttimezone | string | 港口所在时区 |
# 5.7 区域提醒推送数据说明
# 5.7.1 推送说明
推送船舶在指定区域的事件。
# 5.7.2 推送数据示例
{
"shipname": "HUA JIANG 8", //船舶名称//
"ShipID": 413304330, //船舶mmsi号
"callsign": "BHZV3", //呼号//
"imo": 9651644, //IMO//
"areaname": "测试", //区域名称//
"status": 1, //1 到达区域 2 离开区域//
"thetime": "2018-12-25 03:55:14", //提醒时间,年-月-日 时:分:秒//
"timeutc": 1545681314 //AIS 船位 UTC 时间戳//
}
# 5.7.3 推送字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| shipname | string | 船舶名称 | |
| ShipID | long | 船舶MMSI | |
| callsign | string | 船舶呼号 | |
| imo | int | IMO号 | |
| areaname | string | 区域名称 | |
| status | int | 状态值 | 1:到达区域 2:离开区域 |
| thetime | string | 发生事件的时间 | |
| timeutc | long | 时间戳 |
# 6 气象数据接口
# 6.1 实时气象
按坐标点查询该点的气象数据。
# 6.1.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/GetNowMeteorological?k=ea11553d6acb436fadae9c49ed8e150e&lon=122663475&lat=31777556
# 6.1.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| lon | 经度 | 是 | 乘以1000000 | |
| lat | 纬度 | 是 | 乘以1000000 |
# 6.1.3 返回结果示例
{
"status":"0",
"lon":122.663475,
"lat":31.777556,
"tzshift":28800,
"result": {
"precipitation": {
"local": {
"datasource":"radar",
"intensity":0
}
},
"pres":100775.36,
"visibility":14498,
"temperature":27.84,
"skycon":"WIND",
"humidity":0.85,
"swell": {
"swellheight": 0.92,
"swelldir": 216.57,
"swellperiod": 4.81
},
"wave": {
"waveheight":1.95
},
"wind": {
"speed":10.96,
"direction":2.38,
"wind_grade":6
}
}
}
# 6.1.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| lon | float | 经度 | |
| lat | float | 纬度 | |
| tzshift | int | 时区偏移秒数 | |
| result | JsonObj | 结果集 | |
| precipitation | JsonObj | 降水 | |
| local | JsonObj | 本地降水信息 | |
| datasource | string | 数据源(radar、GFS) | |
| intensity | float | 降水强度 | |
| pres | int | 气压,单位:Pa | |
| visibility | int | 能见度,单位:米 | |
| temperature | float | 温度,单位:℃ | |
| skycon | string | 天气状况 | |
| humidity | float | 相对湿度 [0,1] | |
| swell | string | 涌 | |
| swellheight | double | 涌高,单位:米;9.999000260554009E20为无效值 | |
| swelldir | double | 涌向,正北为0,单位:度;9.999000260554009E20为无效值 | |
| swellperiod | float | 涌平均周期,单位:秒 | |
| wave | JsonObj | 浪 | |
| waveheight | double | 浪高,单位:米;9.999000260554009E20为无效值 | |
| wind | JsonObj | 风 | |
| speed | float | 风速 单位:m/s | |
| direction | float | 风向,正北为0,顺时针,单位:度 | |
| wind_grade | int | 风力等级 |
# 6.2 预测气象
根据坐标点返回未来5天气象。
# 6.2.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/GetForecastMeteorological?k=key&lon=122663475&lat=31777556
# 6.2.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| lon | 经度 | 是 | 乘以1000000 | |
| lat | 纬度 | 是 | 乘以1000000 |
# 6.2.3 返回结果示例
{
"status": "0",
"lon": 122.663475,
"lat": 31.777556,
"tzshift": 28800,
"result": {
"precipitation": [{
"datetime": "2020-08-04 14:00",
"value": 0.0003
}],
"pres": [{
"datetime": "2020-08-04 14:00",
"value": 100565.766
}],
"visibility": [{
"datetime": "2020-08-04 14:00",
"value": 11014
}],
"temperature": [{
"datetime": "2020-08-04 14:00",
"value": 27.63
}],
"skycon": [{
"datetime": "2020-08-04 14:00",
"value": "RAIN"
}],
"humidity": [{
"datetime": "2020-08-04 14:00",
"value": 0.85
}],
"swell": [{
"swellheight": 1.07,
"swelldir": 152.88,
"swellperiod": 6.71,
"datetime": "2020-08-06 11:00"
}],
"wave": [{
"value": 2.22,
"datetime": "2020-08-04 14:00"
}],
"wind": [{
"datetime": "2020-08-04 14:00",
"speed": 11.67,
"direction": 2.61,
"wind_grade": 6
}]
}
}
# 6.2.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| lon | float | 经度 | |
| lat | float | 纬度 | |
| tzshift | int | 时区偏移秒数 | |
| result | JsonObj | 结果集 | |
| precipitation | JsonArr | 降水量 | |
| pres | JsonArr | 气压 | |
| visibility | JsonArr | 能见度 | |
| temperature | JsonArr | 温度 | |
| skycon | JsonArr | 天气 | |
| humidity | JsonArr | 湿度 | |
| swell | JsonArr | 涌 | |
| wave | JsonArr | 浪 | |
| wind | JsonArr | 风 | |
| datetime | string | 预报时间,北京时间,格式:yyyy-MM-dd HH:mm | |
| swellheight | double | 涌高,单位:米;9.999000260554009E20为无效值 | |
| swelldir | double | 涌向,正北为0,单位:度;9.999000260554009E20为无效值 | |
| swellperiod | float | 涌平均周期,单位:秒 | |
| speed | float | 风速 单位:m/s | |
| direction | float | 风向,正北为0,顺时针,单位:度 | |
| wind_grade | int | 风力等级 | |
# 6.3 台风列表接口
根据时间段查询台风信息列表。
# 6.3.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/getTyphoonsForTime?k=key&begin=1514764800&end=1538352000
# 6.3.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| begin | 开始时间 | 是 | ||
| end | 结束时间 | 是 |
# 6.3.3 返回结果示例
{
"status": "0",
"result": [{
"ename": "SON-TINH",
"cname": "山神",
"id": "201809",
"start_time": 1531720800,
"end_time": 1531944000,
"land_time": "1531860600",
"land_addr": "海南万宁",
"land_info": "台风“山神”于7月18日早晨4时50分前后在海南万宁市万成镇登陆",
"land_lon": 110.5,
"land_lat": 18.8,
"isactive": "0",
"sources": "2"
}]
}
# 6.3.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| result | JsonArray | 结果集 | |
| ename | string | 英文名称 | |
| cname | string | 中文名称 | |
| id | string | 台风ID | |
| start_time | int | 开始时间,UTC秒 | |
| end_time | int | 结束时间,UTC秒 | |
| land_time | string | 登陆时间,UTC秒 | |
| land_addr | string | 登陆地址 | |
| land_info | string | 登陆信息 | |
| land_lon | float | 登陆经度,单位:° | |
| land_lat | float | 登陆纬度,单位:° | |
| isactive | string | "0"不活跃,"1"活跃 | |
| source | string | "2"浙江台风网,"4"世界气象组织 |
# 6.4 查询历史台风位置及预测值
查询时间范围内历史台风轨迹和当时的预测值。
# 6.4.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/getTyphoonDetails?k=key&begin=1514764800&end=1538352000&type=1
# 6.4.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| begin | 开始时间 | 是 | ||
| end | 结束时间 | 是 | ||
| type | 类型 | 是 | 固定值1 |
# 6.4.3 返回结果示例
{
"status": "0",
"result": [{
"ename": "SON-TINH",
"cname": "山神",
"start_time": 1531720800,
"end_time": 1531944000,
"land_time": "1531860600",
"land_addr": "海南万宁",
"land_info": "台风“山神”于7月18日早晨4时50分前后在海南万宁市万成镇登陆",
"land_lon": "110.5",
"land_lat": "18.8",
"sources": "2",
"presents": [{
"present_time": 1531720800,
"present_lon": 123.7,
"present_lat": 18.9,
"present_strong": "热带低压",
"present_power": "7",
"present_movespeed": 28,
"present_max_wind_speed": 15,
"present_seven_radius": "",
"present_seven_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"present_eight_radius": "",
"present_eight_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"present_ten_radius": "",
"present_ten_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"present_twelve_radius": "",
"present_twelve_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
}
}]
}]
}
# 6.4.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| result | JsonArray | 结果集 | |
| ename | string | 英文名称 | |
| cname | string | 中文名称 | |
| start_time | int | 开始时间,UTC秒 | |
| end_time | int | 结束时间,UTC秒 | |
| land_time | string | 登陆时间,UTC秒 | |
| land_addr | string | 登陆地址 | |
| land_info | string | 登陆信息 | |
| land_lon | float | 登陆经度,单位:° | |
| land_lat | float | 登陆纬度,单位:° | |
| isactive | string | "0"不活跃,"1"活跃 | |
| source | string | "2"浙江台风网,"4"世界气象组织 | |
| presents | JsonArray | 轨迹点 | |
| present_time | int | 轨迹点时间,UTC秒 | |
| present_lon | float | 经度,单位:° | |
| present_lat | float | 纬度,单位:° | |
| present_strong | string | 强度 | |
| present_power | string | 风力等级 | |
| present_movespeed | float | 移动速度,单位:公里/小时 | |
| present_max_wind_speed | float | 最大风速,单位:米/秒 | |
| present_seven_radius | float | 7级风圈最大半径,单位:公里 | |
| present_seven_radius_values | JsonObj | 7级风圈值 | |
| present_eight_radius | float | 8级风圈最大半径,单位:公里 | |
| present_eight_radius_values | JsonObj | 8级风圈值 | |
| present_ten_radius | float | 10级风圈最大半径,单位:公里 | |
| present_ten_radius_values | JsonObj | 10级风圈值 | |
| present_twelve_radius | float | 12级风圈最大半径,单位:公里 | |
| present_twelve_radius_values | JsonObj | 12级风圈值 | |
| neq | string | 东北向风圈半径 | |
| nwq | string | 西北向风圈半径 | |
| seq | string | 东南向风圈半径 | |
| swq | string | 西南向风圈半径 |
# 6.5 查询当前台风位置及预测值
查询当前活跃的台风位置和预测值、历史轨迹点和历史轨迹点预测值。
# 6.5.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/getTyphoonDetails?k=key&type=2&nodetype=all
# 6.5.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| type | 类型 | 是 | 固定值2 | |
| nodetype | 节点数量控制 | 是 | 固定值 all |
# 6.5.3 返回结果示例
{
"status": "0",
"result": [{
"ename": "BETA",
"cname": "",
"start_time": 1600383600,
"end_time": "",
"land_time": "",
"land_addr": "",
"land_info": "",
"land_lon": "",
"land_lat": "",
"sources": "4",
"presents": [{
"present_time": 1600383600,
"present_lon": -94.3,
"present_lat": 21.9,
"present_strong": "热带低压",
"present_power": "7",
"present_movespeed": 7.41,
"present_max_wind_speed": 15.43,
"present_seven_radius": "",
"present_seven_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"present_eight_radius": "",
"present_eight_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"present_ten_radius": "",
"present_ten_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"present_twelve_radius": "",
"present_twelve_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"forecasts": [{
"forecast_time": 1600383600,
"data_source": "17",
"forecast_lon": -94.3,
"forecast_lat": 21.9,
"forecast_strong": "热带低压",
"forecast_power": "7",
"forecast_movespeed": 7.41,
"forecast_max_wind_speed": 15.43,
"forecast_seven_radius": "",
"forecast_seven_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"forecast_eight_radius": "",
"forecast_eight_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"forecast_ten_radius": "",
"forecast_ten_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"forecast_twelve_radius": "",
"forecast_twelve_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
}
}]
}]
}]
}
# 6.5.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| result | JsonArray | 结果集 | |
| ename | string | 英文名称 | |
| cname | string | 中文名称 | |
| start_time | int | 开始时间,UTC秒 | |
| end_time | int | 结束时间,UTC秒 | |
| land_time | string | 登陆时间,UTC秒 | |
| land_addr | string | 登陆地址 | |
| land_info | string | 登陆信息 | |
| land_lon | float | 登陆经度,单位:° | |
| land_lat | float | 登陆纬度,单位:° | |
| isactive | string | "0"不活跃,"1"活跃 | |
| source | string | "2"浙江台风网,"4"世界气象组织 | |
| presents | JsonArray | 轨迹点 | |
| present_time | int | 轨迹点时间,UTC秒 | |
| present_lon | float | 经度,单位:° | |
| present_lat | float | 纬度,单位:° | |
| present_strong | string | 强度 | |
| present_power | string | 风力等级 | |
| present_movespeed | float | 移动速度,单位:公里/小时 | |
| present_max_wind_speed | float | 最大风速,单位:米/秒 | |
| present_seven_radius | float | 7级风圈最大半径,单位:公里 | |
| present_seven_radius_values | JsonObj | 7级风圈值 | |
| present_eight_radius | float | 8级风圈最大半径,单位:公里 | |
| present_eight_radius_values | JsonObj | 8级风圈值 | |
| present_ten_radius | float | 10级风圈最大半径,单位:公里 | |
| present_ten_radius_values | JsonObj | 10级风圈值 | |
| present_twelve_radius | float | 12级风圈最大半径,单位:公里 | |
| present_twelve_radius_values | JsonObj | 12级风圈值 | |
| forecasts | JsonArray | 轨迹点 | |
| forecast_time | int | 轨迹点时间,UTC秒 | |
| forecast_lon | float | 经度,单位:° | |
| forecast_lat | float | 纬度,单位:° | |
| forecast_strong | string | 强度 | |
| forecast_power | string | 风力等级 | |
| forecast_movespeed | float | 移动速度,单位:公里/小时 | |
| forecast_max_wind_speed | float | 最大风速,单位:米/秒 | |
| forecast_seven_radius | float | 7级风圈最大半径,单位:公里 | |
| forecast_seven_radius_values | JsonObj | 7级风圈值 | |
| forecast_eight_radius | float | 8级风圈最大半径,单位:公里 | |
| forecast_eight_radius_values | JsonObj | 8级风圈值 | |
| forecast_ten_radius | float | 10级风圈最大半径,单位:公里 | |
| forecast_ten_radius_values | JsonObj | 10级风圈值 | |
| forecast_twelve_radius | float | 12级风圈最大半径,单位:公里 | |
| forecast_twelve_radius_values | JsonObj | 12级风圈值 | |
| neq | string | 东北向风圈半径 | |
| nwq | string | 西北向风圈半径 | |
| seq | string | 东南向风圈半径 | |
| swq | string | 西南向风圈半径 |
# 6.6 查询指定当前台风
查询指定当前台风轨迹信息。
# 6.6.1 请求地址
http://api.shipdt.com/DataApiServer/apicall/getNowTyphoonDetail?name=BETA&k=key
# 6.6.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| name | 台风名称 | 是 |
# 6.6.3 返回结果示例
{
"status": "0",
"result": [{
"ename": "BETA",
"cname": "",
"start_time": 1600383600,
"end_time": "",
"land_time": "",
"land_addr": "",
"land_info": "",
"land_lon": "",
"land_lat": "",
"sources": "4",
"presents": [{
"present_time": 1600722000,
"present_lon": -96.1,
"present_lat": 28.2,
"present_strong": "Tropical Storm",
"present_power": "8",
"present_movespeed": 7.41,
"present_max_wind_speed": 20.58,
"present_seven_radius": "",
"present_seven_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"present_eight_radius": "",
"present_eight_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"present_ten_radius": "",
"present_ten_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"present_twelve_radius": "",
"present_twelve_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"forecasts": [{
"forecast_time": 1600722000,
"data_source": "17",
"forecast_lon": -96.1,
"forecast_lat": 28.2,
"forecast_strong": "Tropical Storm",
"forecast_power": "8",
"forecast_movespeed": 7.41,
"forecast_max_wind_speed": 20.58,
"forecast_seven_radius": "",
"forecast_seven_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"forecast_eight_radius": "",
"forecast_eight_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"forecast_ten_radius": "",
"forecast_ten_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
},
"forecast_twelve_radius": "",
"forecast_twelve_radius_values": {
"neq": "",
"nwq": "",
"seq": "",
"swq": ""
}
}]
}]
}]
}
# 6.6.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| result | JsonArray | 结果集 | |
| ename | string | 英文名称 | |
| cname | string | 中文名称 | |
| start_time | int | 开始时间,UTC秒 | |
| end_time | int | 结束时间,UTC秒 | |
| land_time | string | 登陆时间,UTC秒 | |
| land_addr | string | 登陆地址 | |
| land_info | string | 登陆信息 | |
| land_lon | float | 登陆经度,单位:° | |
| land_lat | float | 登陆纬度,单位:° | |
| isactive | string | "0"不活跃,"1"活跃 | |
| source | string | "2"浙江台风网,"4"世界气象组织 | |
| presents | JsonArray | 轨迹点 | |
| present_time | int | 轨迹点时间,UTC秒 | |
| present_lon | float | 经度,单位:° | |
| present_lat | float | 纬度,单位:° | |
| present_strong | string | 强度 | |
| present_power | string | 风力等级 | |
| present_movespeed | float | 移动速度,单位:公里/小时 | |
| present_max_wind_speed | float | 最大风速,单位:米/秒 | |
| present_seven_radius | float | 7级风圈最大半径,单位:公里 | |
| present_seven_radius_values | JsonObj | 7级风圈值 | |
| present_eight_radius | float | 8级风圈最大半径,单位:公里 | |
| present_eight_radius_values | JsonObj | 8级风圈值 | |
| present_ten_radius | float | 10级风圈最大半径,单位:公里 | |
| present_ten_radius_values | JsonObj | 10级风圈值 | |
| present_twelve_radius | float | 12级风圈最大半径,单位:公里 | |
| present_twelve_radius_values | JsonObj | 12级风圈值 | |
| forecasts | JsonArray | 轨迹点 | |
| forecast_time | int | 轨迹点时间,UTC秒 | |
| forecast_lon | float | 经度,单位:° | |
| forecast_lat | float | 纬度,单位:° | |
| forecast_strong | string | 强度 | |
| forecast_power | string | 风力等级 | |
| forecast_movespeed | float | 移动速度,单位:公里/小时 | |
| forecast_max_wind_speed | float | 最大风速,单位:米/秒 | |
| forecast_seven_radius | float | 7级风圈最大半径,单位:公里 | |
| forecast_seven_radius_values | JsonObj | 7级风圈值 | |
| forecast_eight_radius | float | 8级风圈最大半径,单位:公里 | |
| forecast_eight_radius_values | JsonObj | 8级风圈值 | |
| forecast_ten_radius | float | 10级风圈最大半径,单位:公里 | |
| forecast_ten_radius_values | JsonObj | 10级风圈值 | |
| forecast_twelve_radius | float | 12级风圈最大半径,单位:公里 | |
| forecast_twelve_radius_values | JsonObj | 12级风圈值 | |
| neq | string | 东北向风圈半径 | |
| nwq | string | 西北向风圈半径 | |
| seq | string | 东南向风圈半径 | |
| swq | string | 西南向风圈半径 |
# 7 区域AIS数据推送
用户推送区域用户需要设置区域、回调地址后才能正常使用该功能;
数据以Socket方式进行数据推送,龙船作为推送的客户端,用户作为服务端;
用户接收到数据后,建议以多线程处理,防止因数据量过大导致数据丢失;
当服务检测到连接中断时,将停止继续发送,10分钟后继续尝试从上次的位置发送数据;
龙船将保存72小时以内的数据,当最后一次发送数据超过72小时后,将从72小时内的数据继续发送。
# 7.1 设置数据回调地址
# 7.1.1 请求地址
http://api.shipdt.com/DataApiServer/dataapi/aisPush/callback?k=key&url=url
# 7.1.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| url | 回调地址 | 是 | 以 IP/域名:PORT格式 |
# 7.1.3 返回结果示例
{
"status":"0",
"message": "错误信息"
}
# 7.1.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| message | string | 错误信息 |
# 7.2 设置区域数据推送区域
用户船舶数据推送的区域范围,区域为一个矩形;
每个账号最多可设置5个区域,单个区域范围不得超过2000*2000海里,若想要更多数据,请联系客服;
数据更新为增量更新;
注:该接口只能以POST方式使用。
# 7.2.1 请求地址
http://api.shipdt.com/DataApiServer/dataapi/aisPush/addArea?k=key
POST BODY中传入区域信息JSON数组
[{
"areaTag": "string",
"maxLat": 0,
"maxLon": 0,
"minLat": 0,
"minLon": 0
}]
# 7.2.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| areaTag | 区域标识符 | 是 | 用户自定义的唯一标识 | |
| minLon | 最小经度 | 是 | 乘以1000000 | |
| minLat | 最小纬度 | 是 | 乘以1000000 | |
| maxLon | 最大经度 | 是 | 乘以1000000 | |
| maxLat | 最大纬度 | 是 | 乘以1000000 |
# 7.2.3 返回结果示例
{
"status":"0"
}
# 7.2.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 |
# 7.3 查询区域数据推送区域列表
# 7.3.1 请求地址
http://api.shipdt.com/DataApiServer/dataapi/aisPush/getArea?k=key
# 7.3.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY |
# 7.3.3 返回结果示例
{
"status":"0",
"result": [{
"areaId": "string",
"areaTag": "string",
"maxLat": 0,
"maxLon": 0,
"minLat": 0,
"minLon": 0
}]
}
# 7.3.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 | |
| areaId | 区域ID | 是 | |
| areaTag | 区域标识符 | 否 | |
| minLon | 最小经度 | 是 | |
| minLat | 最小纬度 | 是 | |
| maxLon | 最大经度 | 是 | |
| maxLat | 最大纬度 | 是 |
# 7.4 修改区域推送区域
# 7.4.1 请求地址
注:该接口只能以POST方式使用。
http://api.shipdt.com/DataApiServer/dataapi/aisPush/modifyArea?k=key
POST BODY中传入区域信息JSON对象
{
"areaId": "string",
"areaTag": "string",
"maxLat": 0,
"maxLon": 0,
"minLat": 0,
"minLon": 0
}
# 7.4.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| areaId | 区域ID | 是 | 可通过查询接口获取 | |
| areaTag | 区域标识符 | 否 | 用户自定义的唯一标识 | |
| minLon | 最小经度 | 是 | 乘以1000000 | |
| minLat | 最小纬度 | 是 | 乘以1000000 | |
| maxLon | 最大经度 | 是 | 乘以1000000 | |
| maxLat | 最大纬度 | 是 | 乘以1000000 |
# 7.4.3 返回结果示例
{
"status":"0"
}
# 7.4.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 |
# 7.5 删除区域数据推送区域
# 7.5.1 请求地址
http://api.shipdt.com/DataApiServer/dataapi/aisPush/removeArea?k=key&areaId=areaId
# 7.5.2 请求参数
| 属性 | 名称 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|
| k | 授权码 | 是 | API KEY | |
| areaId | 区域ID | 是 | 可通过查询接口获取 |
# 7.5.3 返回结果示例
{
"status":"0"
}
# 7.5.4 返回字段说明
| 属性 | 类型 | 名称 | 备注 |
|---|---|---|---|
| status | int | 状态值 |
# 7.6 区域数据推送格式说明
数据以Socket方式进行数据推送,龙船作为推送的客户端,用户作为服务端;
用户接收到数据后,最好进行多线程处理,防止因数据量过大导致数据丢失;
当服务检测到数据发送失败时,将停止继续发送,5分钟后继续尝试从上次的位置发送数据;
龙船将保存72小时以内的数据,当最后一次发送数据超过72小时后,将从72小时内的数据继续发送。
# 7.6.1 数据说明
AIS数据分为动态数据和静态数据,所有数据以"~"分隔
# 7.6.2 静态数据
示例:y 211378190~7928615~DLRD ~KOI ~60~54~10~1~02-28 15:00~21~DEHAM ~A~211~1594955348~100~12~42~5~5
说明:{y} {mmsi}~{imo}~{call sign}~{name}~{ship type}~{length}~{breadth}~{pos fixing device}~{eta}~{draught}~{dest}~{class type}~{country code}~{receive time}~{source id}~{head}~{tail}~{left}~{right}
| 属性 | 含义 | 备注 |
|---|---|---|
| y | 数据类型 | p:动态数据 y:静态数据 |
| mmsi | mmsi | |
| imo | imo | |
| call sign | 呼号 | |
| name | 船舶名称 | |
| ship type | 船舶类型 | 参考AIS船舶类型 |
| length | 船舶长度 | 单位:米 |
| breadth | 船舶宽度 | 单位:米 |
| pos fixing device | 电子定位装置类型 | |
| eta | 预到时间 | 格式:MM-dd HH:mm |
| draught | 吃水 | 单位:米 |
| dest | 目的地 | |
| class type | AIS类型 | Class A/Class B |
| country | 国家代码 | |
| receive time | 接收时间 | UTC |
| source_id | 数据源 | S:卫星 L:岸基 |
| head | 设备到船头的距离 | |
| tail | 设备到船尾的距离 | |
| left | 设备到船左舷的距离 | |
| right | 设备到船右舷的距离 |
# 7.6.3 动态数据
示例:p 412438196~~A~1594955337~73167913~17532075~832~83~1~~0~1594955364~100
说明:{p} {mmsi}~{rot}~{class type}~{position time}~{lon}~{lat}~{course}~{heading}~{speed}~{status}~{accuracy}~{receive time}~{source id}
| 属性 | 含义 | 备注 |
|---|---|---|
| p | 数据类型 | p:动态数据 y:静态数据 |
| mmsi | mmsi | |
| rot | 船舶转向率 | |
| class type | AIS类型 | Class A/Class B |
| position_time | 时间 | UTC |
| lon | 经度 | * 1000000 |
| lat | 纬度 | * 1000000 |
| course | 航迹向 | ° * 10 |
| heading | 船艏向 | ° |
| speed | 航速 | kn * 10 |
| status | 航行状态 | 参考船舶航行状态代码 |
| accuracy | 定位设备精度 | |
| receive_time | 接收时间 | |
| source_id | 数据源 | S:卫星 L:岸基 |