완료 후 후속 처리

계약 상태가 변경될 때마다 이를 감지하여 Webhook을 통해 외부 시스템에 API를 호출하거나 특정 URL로 리디렉션하여 후속 작업을 자동으로 수행하는 기능

후속 처리 관련 데이터 등록 하기

문서 후속 처리(Webhook)을 이용하기 위한 데이터를 등록하는 작업을 진행

[그림1 - 문서 후속 처리 데이터 등록하기]

1. 싸인투게더 화면 우측 상단의 사용자를 클릭 후 나오는 메뉴에서 기업 설정을 선택합니다.

2. 우측 하단의 서비스 연동 관리의 문서 후속 처리의 관리 버튼을 눌러 관리 화면으로 진입합니다.

3. 등록하기 버튼을 눌러 표시되는 팝업에서 알맞은 정보를 기입 후

4. 저장 버튼을 눌러 저장합니다.

문서 후속 처리 프로세스 등록 상세에 대한 설명

[그림2 - 문서 후속 처리 프로세스 등록 상세 설명]

1. 아이디 : 후속 처리 프로세스 ID (필요한 경우, create-document API 호출 시 postProcessId에 기입 )

2. 제목 : 후속 처리 프로세스에 대한 위한 제목(명칭)

3. 설명 : (Optional) 해당 사항에 대한 추가 설명 정보

4. URL : 실제 호출할 URL 주소

5. 메소드 : Restful 메소드 타입(GET,POST,PUT,PATCH,DELETE)

6. 파라미터 타입 : 파라미터 전달 방식 (QueryString or ResponseBody)

7. 동작시점 : 후속 처리 프로세스가 호출되는 시점(복수 선택 가능)

   • 완료 - 계약의 전체 프로세스가 완료되는 시점

   • 거절 - 참여자에 의해 계약이 거절되는 시점

   • 취소 - 요청자에 의해 계약이 취소되는 시점

   • 서명 참여자 서명 완료 - 참여자의 서명 완료 시점(참여자별로 발생)

   • 서명 참여자 문서 첫 조회 - 참여자의 문서 첫 조회 시점(참여자별로 발생)

   • 문서 생성시 - 문서(계약) 생성 시점

   • 서명 재요청 - (서명순서가 있는복수 참여자 계약인 경우에만) 이전 단계로 재요청 하는 시점

   • 철회 요청시 - 요청자에 의해 계약이 철회(파기) 요청되는 시점

   • 참여자가 철회 승인시 - 참여자가 철회(파기)에 대해 승인하는 시점

   • 철회 취소시 - 요청자가 철회(파기) 요청한 건을 다시 취소하는 시점

   • 철회 거절시 - 참여자가 철회(파기) 요청에 대해서 거절하는 시점

   • 철회 되었을 경우 - 계약이 철회(파기) 완료되는 시점

8. 헤더 정보의 암호화를 원하는 경우 체크(등록 시에만 설정 가능)

9. 후속 처리 API 호출에 필요한 헤더 정보

10. 후속 처리 시 전달 받고자 하는 값을 매핑

    • contractId - 문서(계약) ID

    • sharedKey - 공유키 정보

    • status - 문서(계약) 상태

    • extraData - 문서(계약) 내 컴포넌트 데이터 정보

    • metaData - 문서(계약) 내 레이블 데이터 정보

    • message - 취소, 거절 메세지 정보

    • contractors - 참여자 관련 정보

    • additionalData - api로 전달한 추가 정보

    • webhookEventInfo - webhook이 발생한 시점 정보

      • seq : 서명참여자의 seq 정보

        • 0 : 서명요청자

        • 1~5 : 서명 참여자의 시퀀스 정보

      • type : 서명요청자 또는 서명참여자가 취한 액션 정보

        • created : 문서생성

        • firstRead : 서명참여자별로 처음으로 계약 문서를 읽은 시점

        • participantSigned : 서명참여자가 서명한 시점

        • participantRefused : 서명참여자가 거절한 시점

        • completed : 문서가 완료(체결)된 시점

        • refused : 문서가 거절된 시점

        • canceled : 문서가 취소된 시점

        • turnBack : 문서 재요청 시점

        • disposeRequested : 문서 철회(파기) 요청 시점

        • disposeCompleted : 문서 철회(파기)가 완료된 시점

        • disposeCanceled : 서명요청자가 철회 요청을 취소한 시점

        • disposeSigned : 서명참여자가 철회에 동의한 시점

        • disposeRefused : 서명참여자가 철회 요청을 거절한 시점

      ex) {"seq":0,"type":"created"} 형태의 seq와 type으로 구성된 json 문자로 전달됨.