API 키 프로파일

개요

모든 기능이 갖춰진 전용 클라이언트 라이브러리를 사용하지 않더라도 HTTP를 이용하여 쉽게 연동할 수 있습니다. 간단한 스크립트, 혹은 기존의 HTTP 클라이언트 프로그램을 통하여 자동화된 쿼리를 수행하도록 구축할 수 있습니다. 이를 위해서는 먼저 API 키를 발급해야 합니다.

Caution
API 키가 외부에 노출되지 않도록 각별히 주의하십시오. 또한 API 키 사용자의 계정은 최소한의 데이터 접근 권한만 갖도록 하십시오.

API 키는 설정 > API 키 프로파일에서 관리할 수 있습니다.

API 키 프로파일 관리 화면

API 키 목록에서 다음과 같은 정보를 확인할 수 있습니다.

  • API 키: API 키 문자열
  • 사용자: API 키가 할당된 계정
  • 생성일: API 키의 생성일자

API 키 프로파일 추가

API 키 프로파일을 추가하는 방법은 다음과 같습니다.

Note
API 키 프로파일을 추가하기 전에 API 키의 사용 목적에 맞게 권한이 부여된 계정이 있는지 확인하십시오.

  1. 설정 > API 키 프로파일에 있는 도구 모음에서 + 새 API 키 만들기를 누릅니다.

  2. 새 API 키 만들기 창에서 API 키와 사용자 정보를 선택하고 생성을 누릅니다.

    API 키 프로파일 생성

    • API 키: 무작위로 생성되는 4개의 하이픈(-)과 32자의 16진수로 구성된 GUID 문자열. API 키를 갱신하려면 재생성을 누르십시오.
    • 사용자: API 키를 통해 인증할 계정의 로그인 이름. API 키는 계정에 부여된 권한을 부여받습니다.

API 키 프로파일 삭제

  1. 설정 > API 키 프로파일에서 삭제할 API 키를 선택하고, 도구 모음에서 휴지통을 누릅니다.

  2. APIKEY 삭제 창에서 삭제할 API 키를 확인한 다음 삭제를 누릅니다.

    API 키 프로파일 생성

API 쿼리 방법

여기서 설명하는 API는 레거시입니다. 새로운 REST API는 REST API를 참고하십시오.

API 키가 등록되면 /logpresso/httpexport/query 경로를 통하여 쿼리를 수행할 수 있습니다. HTTP 쿼리스트링에 다음과 같은 매개변수를 포함해야 합니다.

  • _apikey: 등록된 API 키 문자열
  • _q: 로그프레소 쿼리 문자열. URL 인코딩이 필요합니다(가령, 공백문자는 "+"로 쓰여야 합니다.)
  • _limit: 최대 결과 행 갯수
  • _fields: 출력필드 순서 지정, 필드 이름들을 쉼표로 구분하여 순서대로 입력합니다. (logpresso-core 버전 0.7.5부터 지원)

또한, 경로 확장자에 따라 3종의 출력 포맷을 지원합니다. 확장자가 없는 경우 HTML 포맷으로 지정됩니다.

  • /logpresso/httpexport/query.csv: CSV 포맷으로 출력
  • /logpresso/httpexport/query.xml: 엑셀 XML 포맷으로 출력
  • /logpresso/httpexport/query.html: HTML 포맷으로 출력

HTML 및 CSV 출력에서 첫 행은 컬럼 헤더(필드 이름)입니다.

API 쿼리 예시

다음과 같은 방법으로 API를 이용한 쿼리를 시험할 수 있습니다.

  1. 설정 > API 키 프로파일에서 root 계정과 연관된 API 키를 생성합니다. 이렇게 생성된 API 키를 b1195afe-b914-43d1-2ca2-c0d7c70c8497라 가정하겠습니다.

  2. 브라우저를 사용하여 로그프레소 서버에 대해 다음과 같은 주소로 연결합니다. 로그프레소 서버의 주소는 example.com이라 가정합니다.

    https://example.com/logpresso/httpexport/query?_apikey=b1195afe-b914-43d1-2ca2-c0d7c70c8497&_q=logdb+tables

    쿼리를 수행하고 나면 다음과 유사한 결과를 확인할 수 있습니다.

    REST API 쿼리 결과