메일/그룹웨어 매뉴얼
Home > 메일/그룹웨어 > 개발자 센터 > 개발자 센터 이용하기
사용하시는 앱에 결재 프로세스가 필요한 경우, 하이웍스에서 제공하는 API를 이용하여 사용자의 앱에 결재 프로세스를 추가할 수 있습니다.
앱에 있는 본문 내용 등의 정보를 하이웍스 전자결재로 전송할 수 있으며, 문서 상태 조회 API를 이용해 결재 상태를 확인할 수도 있습니다.
연동에 필요한 API는 2가지입니다.
- 전자결재 기안하기 페이지 연동
- 문서 상태 조회 API
양식 아이디 확인
외부에서 기안 프로세스를 진행하기 위해서는 양식이 필요합니다.
양식함 관리에서 연동할 양식을 정한 후, 양식 상세 페이지에서 양식 아이디를 확인하세요.
양식 아이디 확인 방법은 아래와 같습니다.
1. 슈퍼 관리자 또는 전자 결재 관리자 계정으로 하이웍스 오피스에 로그인합니다.
2. [전자결재 > 관리자 설정 > 양식함 관리]를 클릭 후 연동할 양식의 양식명을 클릭합니다.
연동할 양식이 없는 경우, 새로 생성하거나 하이웍스 제휴 양식을 이용해 주세요.
3. 상세 페이지 상단의 양식 아이디를 확인합니다.
'지출 결의서'의 경우 현재 연동이 불가합니다. (추후 제공)
'하이웍스 제공 양식'에는 외부 솔루션과 연동할 수 있는 많은 양식을 확인할 수 있습니다.
상단 [양식 수정]을 클릭한 수정 페이지에서 양식 ID 우측의 '작성 페이지 및 팝업에서 사용 불가' 체크 설정 시, 해당 양식은 하이웍스 전자결재 내에서 기안할 수 없는 외부 연동 전용으로 변경됩니다.
기안하기 페이지 호출
1. 애플리케이션 내 결재 프로세스가 필요한 영역에 [결재하기] 등의 버튼을 생성합니다.
2. 해당 버튼의 역할은 브라우저에서 페이지를 이동하거나 새로운 창을 열어 기안하기 페이지 URL을 호출하는 기능입니다.
(URL의 주소는 https://office.hiworks.com/{고객 도메인}/approval/popup/write입니다.)
화면을 호출할 때 양식 아이디(form_id)가 반드시 포함되어야 합니다.
3. 해당 작업이 정상적으로 완료되었다면, 인증에 필요한 로그인 화면을 호출합니다.
4. 로그인 성공 시, 파라미터로 전달한 값이 포함된 기안 문서가 열립니다.
5. 결재선을 설정한 후 [기안하기] 버튼을 클릭하면 기안이 완료됩니다.
6. 파라미터에 Callback_url을 전달한 경우, callback 서버에서 아래와 같은 상태값을 수신합니다.
해당 값은 문서 상태 조회 API를 이용하는 경우 사용됩니다.
office_id={오피스고유번호}&approval_key={문서 KEY}&approval_id={문서 아이디}&approval_code={문서 번호}&state={기안 상태}&request_hash={해쉬값}
※기안상태 => complete: 승인, Progress: 진행 중, Rejected: 반려, Cancelled: 기안취소
단순 기안하기 기능만 요구하는 경우 현재 스텝에서 연동 작업을 종료해도 됩니다.
문서 상태 조회
1. 문서 상태값 조회가 필요한 부분에 [결재 상태값 조회] 버튼을 생성합니다.
2. 문서 아이디를 파라미터로 문서 결재 상태를 조회하는 API를 호출합니다.
문서 상태 조회 API는 헤더에 Office Token이 필요합니다.
3. 호출이 정상적일 경우, 문서 상태값이 정상적으로 Return되는 것을 확인할 수 있습니다.
4. 문서 상태를 애플리케이션 페이지에 표시하거나 필요한 프로세스 처리를 진행합니다.