NAVER WORKS API
NAVER WORKS API는 NAVER WORKS와의 연동 기능을 제공한다.
개발자는 NAVER WORKS API를 사용하여 Bot 사용, 조직 및 그룹 관리, 파일 업로드/다운로드 등 NAVER WORKS에서 제공하는 다양한 기능과 리소스를 활용하는 앱을 개발할 수 있다.
NAVER WORKS API 사용 흐름 {#how-api-works}
NAVER WORKS API는 다음과 같은 과정을 거쳐 실행된다.
- API를 호출하려면 Access Token이 필요하다. Developer Console에서 앱을 생성하고 앱 정보를 사용해 Access Token을 발급받는다. 자세한 내용은 인증을 참고한다.
- Access Token을 사용하여 API 서버에 API 요청을 보낸다. API의 공통 규격은 API 호출을 참고한다.
API 문서 {#api-reference}
API 문서는 각 API의 기능과 요청 방법, 응답값 등의 정보를 제공하며, API를 사용하기 전에 반드시 확인해야 한다.
API 카테고리 {#category}
NAVER WORKS API는 여러 카테고리로 분류된다. 각 카테고리의 설명과 개요 페이지 링크는 다음과 같다.
| 카테고리 | 설명 |
|---|---|
| Bot | Bot에서 메시지를 보내고 메뉴를 설정하고 Bot을 관리할 수 있다. |
| Directory | 구성원, 조직, 그룹 등 사용자 및 조직에 대한 리소스를 관리한다. |
| Calender | 일정 조회, 생성, 수정, 삭제 및 캘린더를 관리한다. |
| Board | 게시판이나 게시글, 댓글을 관리한다. |
| Note | 조직/그룹 노트의 관리한다. |
| Contact | 연락처 및 연락처 태그를 관리한다. |
| Drive | 내 드라이브, 공용 드라이브, 조직/그룹 폴더를 관리한다. |
| 메일 발송·읽기·삭제나 메일함·자동 분류 등의 설정을 관리한다. | |
| Task | 할 일 및 할 일 카테고리를 관리한다. |
| Audit | 감사 데이터를 관리한다. |
| Monitoring | 모니터링 데이터를 관리한다. |
| Security | 외부 브라우저의 사용을 설정한다. |
용어 {#glossary}
API 문서에서는 스키마의 특성을 나타내기 위해 다음과 같은 용어를 사용한다.
- type: 데이터 유형
- string: 문자열
- number: 숫자
- integer: 정수
- boolean: 참/거짓
- array: 배열
- object: 객체
- 문자열
- maxLength: 최대 길이
- minLength: 최소 길이
- 숫자
- maximum: 최댓값
- minimum: 최솟값
- 배열
- maxItems: 원소 최댓값
- minItems: 원소 최솟값
- 기타
- default: 기본값
- required: 필숫값
- enum: 미리 정의된 상숫값
- example: 사용 예
- pattern: 값을 표현하는 패턴
- format: 값의 유형
- writeOnly: 쓰기 전용 속성
- readOnly: 읽기 전용 속성