감사 API 개요

    LINE WORKS는 LINE WORKS 감사 서비스의 기능 중에서 자주 사용하는 기능을 API로 제공한다. LINE WORKS 감사 API는 HTTP 요청으로 활용할 수 있으며, API 결과는 JSON 형식으로 반환하거나 파일 형태로 다운로드할 수 있게 제공한다. 인증 방식으로는 OAuth 2.0을 사용한다.

    API 공통 정보

    제공 종류

    LINE WORKS에서는 서비스 API와 서버 API를 제공한다. 그러나 감사 API는 서버 API만을 제공한다. API 개요를 참고한다.

    제공 환경

    LINE WORKS에서는 테스트와 서비스의 2가지 환경을 제공한다. 그러나 감사 API는 서비스 환경에서만 사용할 수 있다.

    서비스 환경: https://kr1-audit.worksmobile.com
    오퍼레이션을 요청할 때는 HTTP 메서드와 요청 URL을 결합한다. 예를 들어, 드라이브 서비스 환경에서 감사 데이터를 다운로드하는 오퍼레이션은 다음과 같다.

    예) 감사 다운로드 API

    GET https://kr1-audit.worksmobile.com/works/audit/log/drive/logs.csv?rangeName=tenant&rangeValue=2001&_startDate=20171221&_endDate=20180226&_tenantId=2001&_domainId=500&rangeName=tenant&serviceId=audit&apiId=downCsvLog&version=v1
    

    개별 API 설명에서 서비스 환경의 요청 URL을 확인할 수 있다.

    Request 공통

    LINE WORKS 액세스 토큰과 컨슈머키

    API를 호출할 때는 반드시 헤더에 LINE WORKS 액세스 토큰과 컨슈머키를 포함해야 한다.

    토큰과 키 발급은 API 공통 가이드에서 "서버 API" 항목을 참고한다.

    헤더에 LINE WORKS 액세스 토큰과 컨슈머키를 설정하는 방법은 다음과 같다.

    httpMethod.setRequestHeader("Authorization",Bearer "LINE WORKS Access Token"); httpMethod.setRequestHeader("consumerKey", "컨슈머키");

    공통 파라미터

    파라미터
    타입
    필수
    설명
    값(예)
    apiId
    String
    Y api를 구분짓는 ID downCsvLog (각 api마다의 고정값)
    serviceId
    String
    Y 서비스 ID audit (감사는 audit로 고정)
    version
    String
    N 버전. 없으면 기본값 v1 v1