1. 다우오피스 OpenAPI 서비스란?
API란 Application Programming Interface의 약자이며 응용 프로그램에서 사용할 수 있도록 운영 체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있도록 만든 인터페이스입니다. 다우오피스 OpenAPI 서비스는 다우오피스 설치형, 단독형, 구축형을 이용하시는 고객에게 근태정보, 전자결재, 알림 발송, works 연동 등 다양한 API를 제공하여보다 나은 웹 서비스 이용에 기여하는 것에 목적이 있습니다. 개발자는 제공된 OpenAPI를 활용하여 그룹웨어의 데이터를 타 시스템과 연계할 수 있습니다.
2. DOAS(DaouOffice API System)란?
다우오피스 OpenAPI 서비스를 이용하기에 앞서 DOAS의 개념을 이해하시면 더욱 원활한 개발이 가능합니다. DOAS란 DaouOffice API System의 약자로 편리하고 안전하게 다우오피스 OpenAPI를 호출하기 위한 다우기술 자체 구축 시스템입니다. 다우 IDC 내 Cloud 환경에서 운영되고 있으며 외부 업무시스템과 다우오피스 서버 사이에 위치하여 양 시스템 간의 안전한 API 통신이 가능하도록 중계 역할을 해줍니다. 실시간 연동 로그 기록을 수행하고 있기에 개발 시 데이터 확인에 용이합니다. 아래 연동 흐름도를 참고 바랍니다.
① API 호출: API 호출을 위해 필요한 사항을 정리하고 외부 업무시스템에서 DOAS로 API 호출합니다.
② 데이터 확인: DOAS는 업무시스템으로부터 전달받은 인증키, 요청 데이터의 이상 유무를 확인합니다. 이상 있을 시 오류 응답을 업무시스템으로 리턴합니다.
③ API 호출: 전달된 데이터에 이상이 없을 시 고객사 다우오피스 서버로 다시 한 번 API 호출을 진행합니다. 임직원 근태 기록의 경우 중복 데이터 여부를 판단하여 중복일 경우 액션을 취하지 않고, 신규 데이터가 발생할 시 액션을 취합니다.
④ 호출에 따른 액션: 고객사 다우오피스 서버는 DOAS로부터 전달받은 Request를 확인 후 액션을 취합니다.
⑤ 처리 결과 리턴: ②번 과정처럼 다우오피스에서도 데이터의 이상 유무를 확인 후 처리 결과를 DOAS로 리턴합니다.
⑥ 응답값 확인: DOAS는 다우오피스로부터 전달된 값의 이상 유무를 확인합니다.
⑦ 로그 기록: 이상 유무를 확인 후 DOAS 로그에 해당 액션 결과를 기록합니다.
⑧ 처리 결과 리턴: DOAS는 응답값을 정제하여 업무시스템으로 전달합니다.
⑨ 처리 결과 반영: 업무시스템 개발자는 DOAS로부터 전달된 값을 확인 후 결과를 반영합니다.
다우기술에서는 업무시스템에서 다우오피스 서버로의 직접 API 호출을 권장하지 않고 있으며, DOAS를 통해 API 호출하는 방식을 권장합니다. DOAS에 등록된 고객에게만 발급되는 인증키를 통해 API 호출 시 DOAS에 인증을 받으며, 인증 완료 후 DOAS와 다우오피스 간 API 통신이 일어나기 때문에 고객사의 다우오피스 서버 내 데이터 탈취, 조작 등의 위험성을 제거합니다.
3. 다우오피스 OpenAPI 이용 안내
OpenAPI를 사용하기 위해서는 연동 활성화 및 고유 인증키 발급 절차가 필요합니다. 인증키는 고객사당 1개씩만 발급되며, 타 고객사에 양도할 수 없습니다.
OpenAPI 연동 신청 절차는 아래와 같습니다.
① 고객사: 다우오피스 API 센터를 통해 OpenAPI 연동 신청
② 다우기술: 해당 고객사 그룹웨어 OpenAPI 연동 활성화
③ 고객사: 인증키 발급 내역 확인 및 OpenAPI 사용 설정
④ 고객사: 스펙 문서를 참고하여 OpenAPI 사용(개발)
OpenAPI는 REST(Representational State Trasnfer) API 방식으로 구현되어, HTTP 웹 서비스 기반으로 제공되며 결과 데이터는 범용적인 JSON (charset=UTF-8) 포맷으로 제공됩니다. 때문에 개발해야하는 클라이언트 프로그래밍 언어에 제약이 없으며 원하는 언어로 쉽게 개발하실 수 있습니다.
※ 다우오피스 OpenAPI 서비스는 설치형, 단독형, 구축형을 이용하시는 고객에게 제공됩니다.