공공용 API 사용법

문서 소개

NAVER WORKS와 상호 작용하는 앱을 개발하는 데 필요한 NAVER WORKS API 2.0의 사용법을 안내한다.
NAVER WORKS API란? >

사용 방법

NAVER WORKS API 2.0을 사용하려면 다음 절차를 따른다.

  1. NAVER WORKS 관리자 계정으로 Developers Console에 로그인한다.
  2. API를 사용할 수 있도록 NAVER WORKS에 앱을 등록한다.
  3. 등록한 앱에서 사용할 API의 scope를 등록한다.
  4. 앱에서 API 호출을 위한 액세스 토큰(access token)을 발급받는다.
  5. 앱에서 API를 호출한다. 요청 및 응답 본문에서 데이터 형식을 표현하기 위해 JSON(JavaScript Object Notation)을 사용한다. JSON의 형식과 구조에 대한 자세한 내용은 json.org를 참고한다.

*공공용 콘솔로 접근할 수 있다. Developer Console >

API 엔드포인트 및 인증

NAVER WORKS API 2.0에서 제공하는 모든 API는 REST 형식으로 HTTPS를 통해 엔드포인트에 접속한다.
전체 URL은 접근하는 리소스의 엔드포인트에 따라 달라진다.
민간의 "www.worksapis.com" 는 "gov.worksapis.com"으로 대체하여 사용한다.
인증 URL도 엔드포인트에 따라 달라지므로 주의한다.

구분공공민간
엔드포인트https://gov.worksapis.com/v1.0/...
예) Bot 목록 가져오기
https://gov.worksapis.com/v1.0/bots
자세한 내용은 각 API의 레퍼런스 페이지를 참고한다.
https://www.worksapis.com/v1.0/…
예) Bot 목록 가져오기
https://www.worksapis.com/v1.0/bots
자세한 내용은 각 API의 레퍼런스 페이지를 참고한다.
인증 URL1. Authorization URL
- https://auth.gov-naverworks.com/oauth2/v2.0/authorize
2. Token URL
- https://auth.gov-naverworks.com/oauth2/v2.0/token
3. Refresh URL
- https://auth.gov-naverworks.com/oauth2/v2.0/token
1. Authorization URL
- https://auth.naverworks.com/oauth2/v2.0/authorize
2. Token URL
- https://auth.naverworks.com/oauth2/v2.0/token
3. Refresh URL
- https://auth.naverworks.com/oauth2/v2.0/token

공공용 API 참고 사항

공공용 API 사용 시 다음 사항을 참고한다.

제공 서비스

다음과 같은 API/Developer 기능을 제공한다.

  • Bot
  • Directory
  • Contact
  • Board
  • Note
  • Mail
  • Task
  • Audit *공공에서는 service에서 read-mail(메일 읽음), read-receipt-mail(수신 확인) 로그 조회 가능

미제공 서비스

다음의 기능은 제공되지 않는다.

  • API
    • Bot
      • Bot Secret 재발급
      • 봇이 포함된 메세지방 상세 정보 조회
    • Directory
      • 조직 구성원 목록 조회
      • 그룹 관리자 목록 조회
      • 그룹 관리자 추가
      • 그룹 관리자 삭제
    • Mail
      • 즐겨찾는 연락처 메일함 목록 조회
    • Security
    • Drive
    • Monitoring
  • Drive
  • WOFF
  • App Link

미제공 상품군

다음의 상품군은 제공되지 않는다.

  • Free
  • Premium