floatFirstTOC: right
YAML
복사
이 API는 POP-UP 기반 화면에서 사용되는 인증 토큰을 발급하는 기능을 제공합니다. 발급된 토큰은 화면 임베드 URL에 적용되어, 사용자가 별도의 로그인 없이 인증된 상태로 접근할 수 있도록 합니다. 본 API는 반복 호출이 가능하지만, 최근에 발급된 2개의 토큰만 유효하며, 이전 토큰은 자동으로 만료됩니다.
이 API는 POP-UP 기반 임베디드 화면에서 사용되는 인증 토큰을 발급합니다. 발급된 토큰은 임베드 URL에 포함되어, 사용자가 별도의 로그인 없이 화면에 접근할 수 있도록 합니다.
토큰은 24시간 동안 유효하며, 지속적인 접근을 위해 일반적으로 12시간에 한번씩 갱신이 필요합니다. 이 API는 여러 번 호출할 수 있으나, 가장 최근에 발급된 2개의 토큰만 유효하며 이전에 발급된 토큰은 자동으로 만료됩니다.
1. 인증 방법
Token API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.
인증 절차는 다음과 같습니다:
1.
우측 상단의 [Authorize] 버튼을 클릭합니다.
2.
팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.
3.
입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.
4.
인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.
Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.
2. 요청 정보
2-1. 요청 정보
Request URL : [GET] https://insight.seavantage.com/api/token/publish
2-2. 실행 순서
1.
Swagger 문서에서 우측 상단의 Select a definition 메뉴에서 Token 선택
2.
/token/publish 경로로 이동
3.
[Try it out] 클릭
4.
[Execute] 버튼 클릭
5.
하단 응답 영역에서 등록 결과 확인
발급된 토큰은 12시간마다 갱신이 필요합니다.
3. 응답 정보
요청이 성공하거나 실패했을 때 공통적으로 아래와 같은 형식으로 응답이 반환됩니다.
응답 예시
{
"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
복사
응답 필드 상세 설명
응답 항목별 정의
필드명 | 예시 값 | 설명 |
code | 200 | 응답 상태 코드 (HTTP status code와 동일하게 사용됨)코드 목록은 아래 참조 |
message | OK | 응답 메시지 (상태에 따른 설명) |
error | false | 오류 여부
(true: 오류 발생, false: 정상 처리) |
timestamp | 2024-12-01T12:00:00 | 응답 생성 시각 (UTC 기준) |
응답 코드 종류
코드 | 설명 |
200 | 정상 처리 (Success) |
400 | 잘못된 파라미터 (Bad request) |
401 | 인증 필요 (Unauthorized) |
403 | 권한 없음 (Forbidden) |
422 | 처리 불가 (Unprocessable entity) |
429 | 요청 과다 (Too many requests) |
응답 상세 설명
Depth 1 필드 설명 (response 객체)
필드명 | 예시 값 | 설명 | 데이터 타입 |
tokenId | 3a3803cd-e042-4463-9da4-bec0e2974e5c | 토큰 ID | varchar(36) - UUID |
aud | exampleUser@example.com | 사용자 ID | text |
iss | seavantage.com | 토큰 발급 시스템 | text |
iat | 2025-02-26T01:08:09.912566 | 토큰 발급 시간 (UTC 기준) | timestamp |
exp | 2025-03-05T01:08:09.912566 | 토큰 만료 시간 (UTC 기준) | timestamp |