안녕하세요, 네이버웍스입니다.
지난 21년 10월 Beta 공개한 API 2.0 서비스를 정식으로 제공합니다.
API 2.0은 여러 개선 의견과 최신 트렌드를 반영하여 API를 재설계 하였으며, 아래의 개선 사항을 포함하고 있습니다.
1. 완전한 RESTful API 로 직관적이고 일관성있는 인터페이스를 제공
2. OAuth 2.0 기반의 표준화된 인증/권한 체계
3. OAS (OpenAPI Specification 3.0) 기반의 레퍼런스 문서
4. API endpoint 에서 account ID 이외에도 다양한 유저 식별자 사용 지원
4/1(금)부터는 Developers 홈페이지에 접속하여 ‘Document‘ 선택 시 API 2.0 기반으로 웹페이지를 보실 수 있으며,
기존 API 문서, SSO, NAVER WORKS 아이디로 로그인 가이드 문서는 하단으로 스크롤하여 확인하실 수 있습니다.
※ 조직 연동 가이드 문서는 API 2.0 문서 내 ‘Directory’에 포함
API 2.0에서 변경되는 주요 내용은 API 2.0 문서 내 ‘Introduction’ 페이지를 참고해주시고,
기존 API 기반 Bot을 API 2.0 기반으로 업그레이드하는 방법은 API 2.0 문서 내 ‘Bot’ 페이지에서 확인해주세요.
※ 문서의 위치는 변경될 수 있음
■ API 2.0 서비스 정식 개시일: 2022년 4월 1일
■ 업데이트 내용
API 2.0 정식 제공과 함께 아래의 기능 개선이 이루어집니다.
1. 공통
– API 2.0 각 문서별 API 설명 개선 및 API Request 상 Property를 상세히 기술
– API 호출 시 오류 메시지 개선
2. Bot
– callback 메시지 형식 변경 및 검증을 위한 bot secret 추가
– [Bot > 메시지(callback) 수신]에서 domainId 제공
– Property 및 callback에 제공되는 유저 식별자를 계정(loginId) -> userId로 변경
3. User
– 유저정보의 Response 에서 customFieldExternalKey 추가
4. Orgunit
– AccessLimit, EmploymentType 에서 domainId 파라미터 제거
5. Board
– 게시판 이름의 Property명 name -> boardName 으로 변경
■ 주의사항
– 앞으로 신규 기능에 대한 API는 API 2.0으로만 제공될 예정이오니 신규 API 체제로의 전환을 권장합니다.
– 기존 API는 API 1.0으로 명칭이 변경되어 당분간 계속 제공되나, 충분한 마이그레이션 기간을 제공 후 서비스가 종료될 예정입니다. API 1.0의 유지보수는 지원하지 않습니다.
– API 2.0 (Beta) 기반으로 개발한 클라이언트 앱과 설정은 수정없이 사용하실 수 있습니다.
이와 관련해서 궁금한 점이 있으신 분은 네이버웍스 헬프센터(1544-5876) 및 온라인 문의하기로 문의 부탁드립니다.
감사합니다.