오픈 API 시작하기

본 문서는 하이웍스 서비스의 다양한 기능을 활용할 수 있는 API에 대한 상세한 설명을 제공합니다. ‘시작하기’ 문서에는 연동 흐름부터 인증 방식에 대한 기본 내용이 포함되어 있으니, 각 기능을 실행하기 전에 아래 내용을 참고해 주시기 바랍니다.

REST API

하이웍스 오픈 API는 HTTP 요청으로 활용할 수 있는 REST API로 제공됩니다. REST API는 페이지를 불러오는 방식과 동일하므로, 요청 URI, 파라미터 만으로도 API를 기능을 호출할 수 있습니다. [REST API Wiki]

애플리케이션

10만 고객 오피스와 연동을 진행할 고객의 솔루션을 의미합니다. 개발자 센터 우측 상단의 로그인을 진행한 후, [애플리케이션 생성] 버튼을 통해 연동 기초 작업에 필요한 Client ID, Client Secret을 발급받을 수 있습니다.

인증 종류

애플리케이션은 Office Token과 (User) Access Token 두 가지 인증을 이용해 하이웍스 오피스 및 하이웍스 사용자 정보에 접근할 수 있습니다.(하나의 Client ID, Client Secret을 이용해 Office Token과 Access Token을 발급받을 수 있습니다.)

1. Office Token: 애플리케이션과 하이웍스 오피스 간 연동되는 Server to Server 인증방식입니다.

API 소개 테이블
명칭 설명
전자결재 문서 기안하기, 문서 상태값 조회하기, 회계정보 연동하기(준비중) 등의 전자결재 연동 기능을 제공합니다.
그룹 (그룹 구성원을 대상으로) 메신저 알림 기능을 제공합니다.

2. Access Token: 애플리케이션과 하이웍스 사용자 간에 연동되는 Oauth 2.0 기반 인증방식입니다. [Oauth Wiki]

API 소개 테이블
명칭 설명
메일 메일 발송 기능 등 메일 서비스 연동 기능을 제공합니다.
문자 문자 발송(UI 제공) 기능을 제공합니다.
그룹 본인이 소속된 그룹에 글을 쓸 수 있는 포스팅 기능을 제공합니다.

데이터 타입

하이웍스에서 제공하는 API의 주요 데이터타입은 String(문자열)으로 제공됩니다. 별도의 표시가 없는 한 String 형태이며 예외의 경우에는 해당 데이터 타입을 표시합니다.

Office Token 발급 절차

애플리케이션과 하이웍스 오피스 간에 연동 인증을 위한 Office Token 발급 프로세스입니다. 자세한 내용은 인증 항목을 참고해주세요.

  1. 1. Office Token 발급을 요청합니다. 해당 요청은 [오피스 관리 > 오피스 API] 페이지 ‘애플리케이션 승인 대기’목록에 표시됩니다.
  2. 2. 오피스 관리자는 [오피스 관리 > 오피스 API] 페이지 ‘애플리케이션 승인 대기’ 목록에서 해당 애플리케이션을 승인합니다.
  3. 3. Office Token용 Callback URL로 Office Token이 전달됩니다.
  4. 4. Callback URL에서 하이웍스 API 서버로 수신 완료값 전달 시, 오피스는 해당 애플리케이션을 최종 승인합니다.

Access Token 발급 절차

애플리케이션과 하이웍스 사용자 간에 연동 인증을 위한 Access Token 발급 프로세스입니다. 자세한 내용은 인증 항목을 참고해주세요.

  1. 1. Authorization code 발급을 요청합니다. 호출 시, 하이웍스 로그인 팝업이 제공됩니다.
  2. 2. 로그인 성공 시, 호출 시 지정한 Callback URL에 Authorization Code가 전송됩니다(URL 리다이렉트)
  3. 3. 전달받은 Authorization Code를 이용해 Access Token을 요청합니다.
  4. 4. Authorization code 검증을 진행한 후 Access Token를 발급합니다.

복수 인증

Access Token, Office Token을 모두 사용하는 애플리케이션 발급 프로세스입니다. Office Token 연동 후 Access Token을 발급받는 순서를 권장합니다.

  1. 1. Office Token 발급을 요청합니다. 해당 요청은 [오피스 관리 > 오피스 API] 페이지 ‘애플리케이션 승인 대기’ 목록에 표시됩니다.
  2. 2. 오피스 관리자는 [오피스 관리 > 오피스 API] 페이지 ‘애플리케이션 승인 대기’ 목록에서 해당 애플리케이션을 승인합니다.
  3. 3. Office Token용 Callback URL로 Token을 전달합니다. Callback URL은 하이웍스 API 서버로 수신 완료처리하여 최종 승인합니다.
  4. 4. Authorization code 발급을 요청합니다. 호출 시, 하이웍스 로그인 팝업이 제공됩니다.
  5. 5. 로그인 성공 시, 호출 시 지정한 Callback URL에 Authorization Code가 전송됩니다(URL 리다이렉트).
  6. 6. 전달받은 Authorization Code를 이용해 Access Token을 요청합니다.
  7. 7. Authorization code 검증을 진행한 후 Access Token를 발급한다. 해당 내용을 Header에 추가하여 API를 이용할 수 있다.
  8. 8. 이후 각 기능의 API 호출을 진행할 수 있습니다.