Skip to main content

1.Security365 로그 조회 API 가이드

Security365 로그 조회를 위한 API 사용 가이드입니다. 본 문서는 고객사에서 로그 데이터를 조회하기 위해 필요한 API 호출 방법, 샘플 요청/응답, 및 오류 처리 방안을 제공합니다. 로그 조회를 원활히 진행하기 위해 본 문서를 참고하여 설정을 완료해 주시기 바랍니다.

1. API Key 키 발급 및 준비 사항​

  1. API Key 사용 안내

    • 로그 조회 API를 사용하려면 API Key가 필요합니다.
    • API Key는 요청 데이터에 포함되어 인증 정보로 사용됩니다.

  2. 필수 사전 준비

    • API 호출 환경 설정 (네트워크 방화벽, IP 허용 목록 등)
    • Access Token 발급 (인증을 위한 보안 토큰)

  3. Access Token 발급

    • Access Token은 API 호출 시 필수로 포함되어야 하며, 인증 서버에서 발급받을 수 있습니다.
    • 요청 헤더에 포함: Authorization: Bearer AccessToken

2. 순차적인 작업 가이드​

2.1. 로그 조회 API 호출​

1. 엔드포인트 정보​

  • Endpoint: POST /v1/siems/externalSearch

2. 요청 본문(Request Body)​

NameType필수Description
sizeinttrue검색 결과 중 가져올 목록 수
filtersjsontrue로그 조회 기간
sortarraytrue정렬 조건 배열
pagination_keyarrayfalse페이징 기준값 배열, 응답 결과의 sort 값을 그대로 사용해야 합니다.
licensestringtrue소프트캠프에서 제공한 라이선스 키

3. 샘플 요청​

{
    "size": 10,
    "filters": { "from": 1735653652984, "to": 1747357192199 },
    "sort": [ { "time": "desc" } ],
    "license": "HWIX-1DGC0-MKQ6-B2HAF"
}

4. 샘플 응답​

{
    "code": 0,
    "total": 100,
    "items": [
        { "time": 1747357192199, "logLevel": "INFO", "event": "LOGIN" }
    ]
}

5. 페이징 처리​

  • 조회 데이터가 많을 경우, pagination_key를 사용해 순차적으로 데이터를 가져옵니다.
  • 첫 호출 응답에서 sort 값을 그대로 다음 요청의 pagination_key로 사용:
{
    "size": 10,
    "filters": { "from": 1735653652984, "to": 1747357192199 },
    "sort": [ { "time": "desc" } ],
    "pagination_key": [1747357192199, "6263DE9F46D0FD2D19A2ABB6C02630A72349BB6AD10F47C0C42F7BA43D5106DE"],
    "license": "HWIX-1DGC0-MKQ6-B2HAF"
}

3. 에러 처리 및 상태 코드​

성공 HTTP Status Code 200 Body (JSON 형식)​

NameTypeDescription
codeint성공 여부 (성공: 0)
totalint검색 결과 총 개수
itemsjson array조건에 맞는 로그 데이터 목록

실패 HTTP Status Code​

HTTP status codeHTTP 메시지설명
400Bad Request요청 정보 오류
401Unauthorized권한 없음
403Forbidden
404Not Found
500Internal Server Error예외 발생
-1기타 에러

4. 문의 및 지원​

API 사용 중 추가 문의 사항이 있을 경우, 아래 연락처로 문의해 주시기 바랍니다: