DocsReferencesChangelog
Docs

redirectUrl 활용하기

임베디드 기능은 임베디드 URL을 통해 서명을 요청하거나, 서명을 입력하는 등의 작업을 할 수 있습니다.
특정한 작업 이후 원하는 페이지로 이동해야 하거나, 해당 작업에 따른 후속 작업이 필요하다면 redirectUrl을 이용할 수 있습니다.

"임베디드 초안 생성 API", "템플릿으로 임베디드 초안 생성 API", "임베디드 문서 열람 URL 조회 API", "임베디드 서명자의 보안링크 조회", "임베디드 템플릿보기 url 조회"는 요청 body에 redirectUrl 정보를 포함하여 요청할 수 있습니다.
redirectUrl 은 HTTP URL 형식을 따르며, 해당 파라미터를 포함해 생성한 임베디드 URL에서는 서명 요청 또는 서명 입력과 같은 작업 후에 해당 URL로 리디렉션되게 됩니다.
또한 리디렉션 시 페이지 URL에 추가로 현재 요청 또는 서명한 문서의 ID정보와 어떤 작업이 진행되었는지에 대한 이벤트 정보가 포함됩니다.

만약 redirectUrl에 추가적인 파라미터를 함께 전달했다면, 리디렉션시 해당 파라미터도 documentId와 함께 전달되므로 필요시 내부 데이터를 함께 전달해 문서ID 보관에 활용하실 수 있습니다.

 

리디렉션 페이지 예시

  • 임베디드 서명 요청 후
    https://example.com/redirect?documentId=DOCUMENT_ID&eventType=document_started

  • 임베디드 서명 입력 후
    해당 서명자의 서명으로 모든 서명이 완료된 경우
    https://example.com/redirect?documentId=DOCUMENT_ID&eventType=document_all_signed
    해당 서명자의 서명 후에도 남은 서명이 있는 경우
    https://example.com/redirect?documentId=DOCUMENT_ID&eventType=document_signed

  • 임베디드 서명에서 거절 시
    https://example.com/redirect?documentId=DOCUMENT_ID&eventType=document_rejected

  • 임베디드 서명에서 나가기 시
    https://example.com/redirect?documentId=DOCUMENT_ID&eventType=exited

  • 임베디드 템플릿 생성 후
    https://example.com/redirect?templateId=TEMPLATE_ID&eventType=template_created

  • 임베디드 템플릿 수정 후
    https://example.com/redirect?templateId=TEMPLATE_ID&eventType=template_edited

Updated 13 days ago