This API issues authentication tokens used for pop-up–based embedded screens. The issued token is applied to the embed URL, enabling users to access the screen without needing to log in separately.
The token is valid for 24 hours. It needs to be renewed every 12 hours to ensure continuous access. While this API can be called multiple times, only the two most recently issued tokens remain valid. Any previously issued tokens will automatically expire.
Authentication
The Token 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.
Token ID Request
Request URL
[GET] https://insight.seavantage.com/api/token/publish
Execution Steps
1.
2.
Navigate to the /token/publish endpoint.
3.
Click [Try it Out].
4.
Click [Execute] to issue a new token.
5.
View the results in the response section at the bottom.
Issued tokens must be renewed every 12 hours.
Response Information
The response is returned in the following format, regardless of whether the request is successful or failed.
Sample Response
{
"code": 200,
"message": "success",
"error": false,
"timestamp": "2025-02-26T10:08:10.005543",
"response": {
"tokenId": "3a3803cd-e042-4463-9da4-bec0e2974e5c",
"aud": "exampleUser@example.com",
"iss": "seavantage.com",
"iat": "2025-02-26T01:08:09.912566",
"exp": "2025-03-05T01:08:09.912566"
}
}
JSON
복사
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 | “2024-12-01T12:00:00” | Time of response creation (UTC) |
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 (response object)
Field | Example Value | Description |
tokenId | 3a3803cd-e042-4463-9da4-bec0e2974e5c | Token ID |
aud | exampleUser@example.com | User ID |
iss | seavantage.com | Token Issuer |
iat | 2025-02-26T01:08:09.912566 | Token Issuance Time (UTC) |
exp | 2025-03-05T01:08:09.912566 | Token Expiration Time (UTC) |