Introduction

    이 문서는 NAVER WORKS와 상호 작용하는 앱을 개발하는 데 필요한 NAVER WORKS API 2.0의 사용법을 설명한다.

    개발자는 NAVER WORKS API 2.0용 앱을 이용해 NAVER WORKS가 제공하는 리소스에 접근할 수 있다. 또한, 메시지 Bot 제어하기, 그룹 추가 및 제거, 파일 업로드하기 등과 같이 NAVER WORKS에서 사용할수 있는 다양한 기능을 API로 이용할 수 있다.

    시작하기 전에

    NAVER WORKS API 2.0을 사용하려면 다음 절차에 따라 API 사용 준비를 한다.

    1. 'Admin > 보안 > 관리자권한' 에서 앱개발자에게Developers권한을 부여한다.（참고）
    2. NAVER WORKS 관리자 계정으로 Developer Console에 로그인한다.
    3. API를 사용할 수 있도록 NAVER WORKS에 앱을 등록한다.
    4. 등록한 앱에서 사용할 API의 scope를 등록한다.
    5. 앱에서 API 호출을 위한 액세스 토큰(access token)을 발급받는다.
    6. 앱에서 API를 호출한다.

    요청 및 응답 본문에서 데이터 형식을 표현하기 위해 JSON(JavaScript Object Notation)을 사용한다. JSON의 형식과 구조에 대한 자세한 내용은 json.org를 참고한다.

    API 사용

    NAVER WORKS API 2.0에서 제공하는 모든 API는 REST 형식으로 HTTPS를 통해 엔드포인트에 접속한다. 접속하는 기본 URL은 (https://www.worksapis.com/v1.0/)이며, 전체 URL은 접근하는 리소스의 엔드포인트에 따라 달라진다. 예를 들어, GET 메서드로 메시지 Bot의 목록을 가져오는 방법은 다음과 같다.

    • GET https://www.worksapis.com/v1.0/bots

      자세한 내용은 각 API의 레퍼런스 페이지를 참고한다.

    NAVER WORKS는 API를 더 편리하게 사용할 수 있도록 지속적으로 개선해 정기, 비정기 릴리스로 배포하고 있다.
    API 업데이트에 대한 자세한 내용은 공지 사항을 참고한다.

    API 사용 중 도움이 필요하면 Community를 이용한다.

    NAVER WORKS API 2.0는 요청 트래픽을 효율적으로 처리할 수 있도록 API 호출 제한(Rate limit)이 있으며, 필요한 경우 이러한 제한값을 변경할 수 있다.