This API allows you to retrieve general information about ports and terminals provided by Port Insight.
Authentication
The Port API uses Basic Authorization on Swagger UI.
Authentication Steps
1.
Click the [Authorize] button in the top right corner.
2.
Enter the provided username and password in the pop-up window.
3.
Click [Authorize] again to proceed with authentication.
4.
After successful login, click [Close] to close the window.
All API requests from Swagger UI will automatically include the authorization token.
Port Insight Request Information
Request URL
Request URL : [GET] https://insight.seavantage.com/api/port-insight
Execution Steps
1.
In the Swagger Documentation, select Port Insight from the Select a definition menu at the top right.
2.
Navigate to the/port-insight endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values according to the following request parameters:
•
portId : The unique Port ID issued by SeaVantage.
5.
Click [Execute].
6.
View results in the response section.
If the access permissions for the requested port were not configured, its information cannot be retrieved via this API. For access requests, please contact cx@seavantage.com.
Response Information
The response is returned in the following format, regardless of whether the request is successful or failed.
Sample Response Format
{
"code": 200,
"message": "OK",
"error": false,
"timestamp": "2024-12-01T12:00:00",
"response": {
"port": {
"portId": "123e4567-e89b-12d3-a456-123456789012",
"portName": "Busan",
"unlocode": "KRPUS",
"nationCode": "KR",
"latitude": 12.3456,
"longitude": 12.3456,
"timezone": "+09:00",
"geoData": "{\\\"type\\\":\\\"MultiPolygon\\\",\\\"coordinates\\\":[[[[128.833127307,35.039946938],\n[128.778530218,35.039998445]]]]}\"\n"
},
"terminals": [
{
"terminalId": "47941f60-13b8-4718-bead-aa7c3c61d530",
"terminalName": "BUSAN CONTAINER TERMINAL (BCT)"
}
]
}
}
JavaScript
복사
Response Field Descriptions
Top-Level Response Fields
Field | Example Value | Description |
code | 200 | Response status code (used in the same way as standard HTTP status codes).
See the list of codes below for reference. |
message | OK | Response message (description based on status) |
error | false | Error flag
true: error occurred
false: successful processing |
timestamp | 2025-05-15T10:56:59.034880881 | Time of response creation (UTC) |
response | null or Object | Returns null or object depending on the context |
Response Codes
Code | Description |
200 | Success |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
422 | Unprocessable entity |
429 | Too many requests |
Detailed Response Description
Depth 1 Field Description (port object)
Field | Example Value | Description | Data Type |
portId | 123e4567-e89b-12d3-a456-123456789012 | Internally used port identifier | varchar(36) - UUID |
portName | Busan | Port name | varchar(255) |
unlocode | KRPUS | Port UNLOCODE | varchar(36) |
nationCode | KR | Country code | varchar(36) |
latitude | 12.3456 | Latitude | double precision |
longitude | 12.3456 | Longitude | double precision |
timezone | +09:00 | Port timezone | |
geoData | {\\\"type\\\":\\\"MultiPolygon\\\",\\\"coordinates\\\":[[[[128.833127307,35.039946938],\n[128.778530218,35.039998445]]]]}\"\n"
} | Port area GeoData |
Depth 2 Field Description (terminals object)
Field | Example Value | Description | Data Type |
terminalId | f66c027a-08d8-11ed-b938-049226dae5ce | Internally used terminal identifier | varchar(36) - UUID |
terminalName | BUSAN CONTAINER TERMINAL (BCT) | Terminal name | varchar(128) |