PORT WEB

API仕様


リクエストURL

船舶検索

http://api.toyoshingo.com/v01/ShipSearch/

港検索

http://api.toyoshingo.com/v01/PortSearch/


パラメータ

船舶検索

パラメータ名 必須 型 説明 備考
Keyid 〇 文字列 アクセスキー 当社より発行したＡＰＩキー
Callsign △ 文字列 コールサイン 検索したい船舶のコールサイン
Name △ 文字列 船名 検索したい船舶の名称(アルファベット)

※△はどちらか一方必須です。

港検索

パラメータ名 必須 型 説明 備考
Keyid 〇 文字列 アクセスキー 当社より発行したＡＰＩキー
Portcode 〇 数値 港コード 当社独自の港コード

リクエストサンプル

コールサイン検索

http://api.toyoshingo.com/v01/ShipSearch/?Keyid=xxxxxxxx&Callsign=JJ1234

船名検索

http://api.toyoshingo.com/v01/ShipSearch/?Keyid=xxxxxxxx&Name=TEST MARU

港検索

http://api.toyoshingo.com/v01/PortSearch/?Keyid=xxxxxxxx&Portcode=11

※「xxxxxxxx」は取得したAPIキーを入れてください。GETのみ対応。


レスポンス

パラメータ名 型 説明 備考
status 数値 ステータス 結果コード(OK=200)
LastUpdate 日付時刻 最終更新日時 例: 2017-12-01 16:00
data - - 検索結果が複数ある場合は件数分
Portcode 数値 港コード 当社独自の港コード

Callsign 文字列 コールサイン

National 文字列 国籍コード

Name 文字列 船名

Ton 数値 総トン数

Berth 文字列 バース名

※ETA 日付時刻 港外到着予定日時

※ETS 日付時刻 港外発予定日時 バースにより異なりますが、着岸(ETB)は＋1時間が目安です。

※ETD 日付時刻 出港予定日時

※時間未定の場合は日付のみとなります。また日時未定の場合は値なし["ETx": ""]となります。


レスポンスサンプル(JSON)

{
"status": 200,
"LastUpdate": "2017-05-26 16:00",
"data": [
        {
        "Portcode": "11",
        "Callsign": "JJ1234",
        "National": "JP",
        "Name": "TEST MARU",
        "Ton": "77777",
        "Berth": "HB4",
        "ETA": "2017-05-26 06:15",
        "ETS": "2017-05-26 06:45",
        "ETD": "2017-05-26 21:00"
        }
        ]
}

エラーコード

エラーコード エラーメッセージ エラー内容
400 アクセス回数上限エラー アクセス回数の上限を超えています。
401 認証エラー APIキーに誤りがあります。
406 パラメータエラー パラメータに誤りがあります。
500 サーバ・エラー Webサービス内で問題が発生しています。

エラーレスポンスサンプル

{
"status": 401,
"message": "認証エラー"
}

港コード一覧

港コード 港名
11 横浜港
13 東京港
35 名古屋港
41 神戸港
40 大阪港

×