Monitor vessels registered in the Fleet along with ports added to the menu in a dashboard format. Depending on the selected options, the vessel’s past track and predicted route can also be displayed, just like in single vessel tracking.
Steps to Use the Screen Embed Service
1. Token Issuance
Issue the user token.
Request URL
[GET] https://insight.seavantage.com/api/token/publish
Execution Steps
1.
2.
Navigate to /token/publish.
3.
Click [Try it out] to activate input fields.
4.
Click [Execute].
5.
View results in the response section.
Notes
•
Tokens are valid for 24 hours. To maintain continuous access, it is recommended to renew them every 12 hours.
•
This API can be called multiple times, but only the two most recently issued tokens remain valid. Previously issued tokens will automatically expire.
2. Embed URL Generation
After issuing the token, combine it with the necessary parameters to generate the embed URL.
Parameter Types
The screen embed feature allows you to configure various ship tracking screens by combining the parameters below. The generated URL can be used in a browser or embedded in an iframe to access the tracking screen.
userToken (required)
•
A valid user token issued by SeaVantage
imoNo (required)
•
IMO Number of the vessel to be tracked (7 digits)
Note
•
If the vessel requested for tracking is not already registered in your workspace, it will be automatically added to the workspace.
startDate (optional)
•
Set the start date for displaying past track data
Field | Description |
auto | Display vessel track from the most recent departure port to its current location |
YYYYMMDD | Display vessel track from the specified date to the current location |
Unspecified / Others | Do not display past track data |
destination (optional)
•
Option to select whether to base destination prediction on the entered port (UNLOCODE) or the AIS Destination.
Field | Description |
unlocode | The destination port is set by entering the destination UNLOCODE, and a port marker will be displayed accordingly.
Examples)
1. destination=KRPUS Sets Busan as the destination port.
2. destination=USLGB Sets Long Beach as the destination port.
3. destination=ABCDE Attempts to set ABCDE as the destination port.
(If the entered port, like in example 3 does not exist in SeaVantage, the destination will fail to register.) |
auto | When set to AIS, the system predicts the destination and displays the port marker based on the vessel’s AIS Destination value. |
Unspecified | When none is set, no destination is defined.
If only the routing=auto parameter is provided without a destination, the system will automatically predict the destination based on the AIS Destination and display the estimated route. |
routing (optional)
•
Select the prediction basis for the estimated route calculation
Field | Description |
auto | Predict the destination and display the estimated route based on the AIS Destination |
destination | Display the estimated route based on the value entered in the destination parameter
Example)
1. destination=UNLOCODE : When a UNLOCODE is entered in the destination parameter, the estimated route will be displayed toward the specified port.
2. destination=auto : When "auto" is entered in the destination parameter, the system predicts the destination using AIS (Automatic Identification System) data.
3. If the destination parameter is not entered, no destination prediction will be made. |
Unspecified / Others | Do not display estimated route. |
size (optional)
•
Choose whether to display vessel details as a pop-up or an info bubble:
Field | Description |
small | Display information as an info bubble above the vessel marker |
Unspecified / Others | Use the standard vessel pop-up |
•
Set the size to small to minimize the display of additional information and show only essential vessel details.
shipCategoryId (optional)
•
Enter the Fleet menu ID to automatically select the corresponding vessel menu.
•
The shipCategoryId is returned as a response when querying vessel categories.
•
Clicking a menu on the right panel will automatically zoom the map to show the locations of the vessels associated with that menu.
Note
•
shipCategoryId can only be used if the category_level of the selected menu is 2.
•
Multiple shipCategoryId values can be entered as a list.
•
If you would like to add shipCategoryId values for menu configuration, please contact cx@seavantage.com.
portCategoryId (optional)
•
Enter the Ports menu ID to automatically select the corresponding port menu.
Note
•
portCategoryIdcan only be used if the category_level of the selected menu is 2.
•
Multiple portCategoryId values can be entered as a list.
•
If you would like to add portCategoryId values for menu configuration, please contact cx@seavantage.com.
Display Settings
•
To display ship names on the map, go to the top-right corner of the screen, click [Layer] → enable the toggle for [Label > Ship name]. This will show the vessel name beneath each ship icon on the map.
Example
1.
Monitor vessels registered in the Fleet, display their past track from the last port of departure to the current location, and show the predicted route based on the AIS Destination.
https://insight.seavantage.com/ship/fleet/tracking?imoNo=9685358&userToken={userToken}&routing=auto&startDate=auto
Plain Text
복사
2.
Monitor the list of vessels registered under the Fleet Active menu.
https://insight.seavantage.com/ship/fleet/tracking?userToken={userToken}&shipCategoryId=27ecdb29-08ec-4880-b73c-dacdd3e6c93c
Plain Text
복사
