개요
다우오피스 OpenAPI 서비스의 전자결재 기안 연동을 위한 <전자결재 기안 API> 입니다. 다우오피스 그룹웨어 전체화면의 형태로 제공하는 방식과 해당 문서만 팝업 형태로 제공하는 방식을 제공합니다. callbackURL을 입력하여 해당 기안 처리상태 정보를 추가적인 API 호출을 통해 전달할 수 있습니다.
하단 첨부파일에서 전자결재 양식 설정 가이드와 샘플 JSP 파일을 다운로드 하실 수 있습니다.
Request URL
| 구분 | Request URL |
|---|---|
| 전체화면 | https://api.daouoffice.com/public/v4/approval/document |
| 팝업화면 | https://api.daouoffice.com/public/v4/approval/document/popup |
※ 다우오피스 OpenAPI 서비스는 DOAS 서버로 API 호출을 진행하기 때문에 별도 고객사 그룹웨어 URL이 아닌 “https://api.daouoffice.com”을 사용합니다.
HTTP Method
POST (Content-Type: application/x-www-form-urlencoded; charset=UTF-8)
Request Parameters
|
변수 (Parameter) |
타입 (Type) |
필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| clientId | String | Y | Y | 고객사 식별/인증을 위한 서비스 인증ID / Client ID ※ <인증키 발급 API>를 통해 전달받은 값 |
| clientSecret | String | Y | Y | 고객사 식별/인증을 위한 서비스 보안KEY / Secret Key ※ <인증키 발급 API>를 통해 전달받은 값 |
| productName | String | N | N | 업무시스템 제품명(제휴시스템 사용할 경우 입력) |
| productVersion | String | N | N | 업무시스템 제품버전(제휴시스템 사용할 경우 입력) |
| clientCompanyName | String | N | N | 업무시스템 고객사 식별정보(제휴시스템 사용할 경우 입력) |
| formCode | String | Y | Y | 다우오피스 전자결재 연동서식 코드 ※ 전자결재 양식 저장 시 기타 - 시스템 연동 - "사용" 체크 - "전자결재연동_v4" 선택 - 코드에 기입한 코드와 일치해야합니다. 외부시스템에서 기안 시 사용할 양식의 code값으로 양식의 고유한 code를 작성하여 두 시스템 간 일치하도록 작성 예시) 코드 입력란에 "daouappr01" 입력하여 저장 |
| title | String | Y | N | 다우오피스 전자결재 제목 |
| draftEmpNo | String | N | N | 양사의 시스템 사원(인식)번호 - 기안자 정보 ※ 사원번호 확인을 할 경우에는 필수전달 |
| content | String | Y | N | 다우오피스 전자결재 본문 HTML |
| attaches | MultipartFile [] | N | N | 전자결재 첨부파일 |
| allianceInfo | String | N | N | 전자결재 공유정보를 위한 Object[배열]을 따옴표("")로 감싼 문자열 |
| callbackUrl | String | Y | N | [업무시스템]에 ‘전자결재 처리상태 전송 API’를 호출할 URL ※ callbackUrl는 80, 443 기본 포트만 허용합니다. ex) https://partner.domain.com/do/document/status |
| partnerDocId | String | N | N | [업무시스템] 문서별 고유식별 정보# <전자결재 처리상태 조회 API>를 이용할 경우에는 필수 |
※ productName, productVersion, clientCompanyName은 외부업무시스템의 정보를 전달받아 문제 발생 시 다우기술에서 로그 확인을 위해 필요한 사항입니다. 필수 입력값은 아니므로 초기 개발 시 비워두고 정식 사용 시 값을 입력하는 것을 권장합니다.
- allianceInfo (업무시스템에서 전달하고자 하는 배열값으로 필요 시에만 작성합니다.)
|
변수 (Parameter) |
타입(Type) |
필수 여부 |
사전 발급 |
설명 (Description) |
|---|---|---|---|---|
| {업무시스템 생성} #1 | String | N | N | 업무시스템에서 전달하는 연동관련 고유정보 #1 |
| {업무시스템 생성} #2 | String | N | N | 업무시스템에서 전달하는 연동관련 고유정보 #2 |
| {업무시스템 생성} #3 | String | N | N | 업무시스템에서 전달하는 연동관련 고유정보 #3 |
Request Example
POST /public/v4/approval/document/popup HTTP/1.1
api.daouoffice.com
Content-Type: multipart/form-data
{
"clientId": "c6e3d3f7e4f5abf1",
"clientSecret": "f4d7bbc9e4b0e7f8bfb2bfa3fcf0e0f7",
"productName": "제휴서비스/제품 명",
"productVersion": "제휴서비스/제품 버전",
"clientCompanyName": "제휴서비스/제품 식별번호",
"formCode": "SlipCredit",
"title": "업부 협조 기안",
"draftEmpNo": "ED207",
"content": "본문 내용 HTML 코드",
"attaches": "work_list.txt",
"allianceInfo": "{"key":"","code":"","info":"","detail":{"no":"","value":""}}",
"callbackUrl": "https://partner.domain.com/do/document/status",
"partnerDocId": "PartnerDoc_AX14211"
}※ API Tester 사용 시 Body의 타입을 "Form"으로 설정 후 테스트하시기 바랍니다.
Response
전자결재 기안 API는 전송 포맷 Content-Type: multipart/form-data 방식이며 연동 리턴값이 없습니다. 전달받은 데이터의 검증은 DOAS의 연동 이력 화면(Site admin – 시스템 연동 – 시스템 연동 – 시스템 연동 페이지 “전자결재 연동로그”)에서 조회 가능합니다.
Return Code
| 구분 |
코드 (Code) |
내용 (Message) |
설명 (Description) |
|---|---|---|---|
|
성공 (Success) |
200 | 성공 | OK |
|
실패 (Error) |
500 | 유효하지 않은 Body | Body 형태를 "Form"으로 설정하세요. |
| 901 | 유효하지 않은 client ID | client ID를 확인하세요. | |
| 902 | 유효하지 않은 client Secret | client Secret을 확인하세요. | |
| 955 | 도메인 코드 오류 | 'XXXX'는 존재하지 않는 도메인 코드입니다. |
제약 사항
| 구분 | 누적 호출 제한 횟수 | 비고 |
|---|---|---|
| 월간 | 600회 | 1회당 첨부 용량 제한(5MB) |
제공 서비스 유형
| 구분 | 제공 여부 |
|---|---|
| 다우오피스 단독형 | 제공 |
| 다우오피스 설치형 | 제공 |
| 다우오피스 구축형 | 제공 |
| 다우오피스 공유형 | 미제공 |