API 요청 로그

[로그] > [API 요청 로그]

⚠️ 이 기능은 패치를 통해 [정책] > [연동 시스템 정책] 메뉴로 통합되었습니다.
연동 시스템 등록, API Key 발급, 정책 설정을 한곳에서 관리할 수 있습니다.
API 요청 로그는 [로그] > [API 요청 로그] 에서 확인할 수 있습니다.

SHIELDEX File의 API 접근 제어 기능은 연동 시스템 단위로 관리자별 접근 권한을 설정하고, API 호출 이력을 확인 및 관리할 수 있도록 지원합니다.
관리자는 연동 시스템을 기준으로 API 접근 권한을 세분화하고, 각 권한별 API Key를 발급하거나 요청 로그를 조회할 수 있습니다.

⚠️ 'API 접근 제어' 설정 권한은 [관리자 유형 - 최고 관리자]에게 있으며,
관리자 권한 설정은 [관리자] > [관리자 목록] 에서 가능합니다.

---

▷ 연동 시스템 등록

API 접근 제어의 기반이 되는 연동 시스템을 등록합니다.

연동 시스템 추가

+ 연동 시스템 추가 버튼 클릭 시 다음 항목을 입력합니다.

항목	설명
연동 시스템 이름	고유 식별 이름 (예: FRD, OPS 등)
레이블	연동 시스템에 대한 설명 또는 명칭

연동 시스템 삭제 시 관련된 접근 설정 및 로그가 모두 삭제되며 복구할 수 없습니다.

제거 안내

• 연관된 접근 제어 설정이 존재하는 경우 삭제할 수 없습니다.
• 삭제 확정 시 연관된 모든 데이터가 함께 삭제되며 복구할 수 없습니다.

▷ 접근 제어 설정

등록된 연동 시스템에 대해 API 접근 권한을 부여할 관리자를 지정하고, API Key를 발급 및 관리합니다.

접근 제어 등록

+ 접근 제어 등록 버튼 클릭 시 다음 항목을 설정합니다.

항목	설명
연동 시스템	선택 가능한 등록된 연동 시스템
담당 연동 시스템 관리자	API 접근 권한이 부여될 관리자 계정

• 등록이 완료되면 API Key가 자동 생성되어 목록에 표시됩니다.

표시 항목

항목	설명
등록 시간	접근 권한이 설정된 일시
연동 시스템	접근 제어 대상 연동 시스템
관리자 ID	접근 권한을 가진 관리자 계정
API Key	인증 시 사용되는 키 (외부 노출 주의)
조치	접근 제어를 해제할 수 있는 버튼 제공

관리자 변경

• 담당 관리자 변경 버튼을 클릭하여 접근 권한을 가진 관리자를 변경할 수 있습니다.

접근 제어 해제

• 해제 버튼을 클릭하면 해당 API Key 및 접근 정책이 삭제됩니다.

▷ 접근 제어 로그

API를 통해 이루어진 요청 이력을 조회할 수 있습니다. 각 요청 기록은 상세한 정보와 함께 제공되며 필터 및 내보내기 기능을 지원합니다.

로그 항목

항목	설명
API	요청 유형 (조회, 다운로드 등)
고객 번호 / 사용자 관리 번호	요청 주체 식별자
연동 시스템 이름 / 레이블	요청 구분 정보
요청 작업 ID	요청을 추적할 수 있는 고유 ID
파일 상대 경로	결과 파일 저장 경로
파일명	처리된 파일 이름
요청 시간 / IP	요청 발생 시간 및 클라이언트 IP
응답 메시지	JSON 형식의 처리 결과
응답 코드	HTTP 상태 코드 (예: 200, 403 등)

필터 기능

• 날짜 범위를 지정하여 특정 기간의 로그를 조회할 수 있습니다.
• 요청 유형 필터(전체, 신청, 조회, 다운로드, 허용, 차단 등)를 통해 구분된 로그 확인이 가능합니다.
• 고객 번호, 사용자 번호, 연동 시스템 이름, 레이블, 파일명 등 다양한 조건으로 필터링할 수 있습니다.

내보내기 기능

• 좌측 상단 내보내기 버튼을 클릭하면 현재 조회 조건에 해당하는 로그를 CSV 파일로 다운로드할 수 있습니다.

CSV 파일은 감사 로그 보관, 보고서 작성, 시스템 연동 오류 추적 등의 목적으로 활용할 수 있습니다.

참고 사항

• 연동 시스템을 활용하여 조직 내 API 접근 권한을 체계적으로 분리합니다.
• API Key는 외부에 노출되지 않도록 관리하며, 필요 시 즉시 해제 후 재등록합니다.
• API 접근 로그는 주기적으로 백업하거나 내보내기 기능을 통해 보관합니다.