DocsReferencesChangelog
Docs

템플릿으로 열람 요청하기

'문서 열람 요청' 은 통지, 확인, 청구 문서에 대해 상대방에게 공유하고 이력을 남기기 위한 기능입니다. 이용자의 계정에 설정된 열람용 템플릿을 기반으로 추가 정보를 입력하여 모두싸인 전자서명을 시작하고, 참여자에게 열람 요청 알림을 발송할 수 있습니다.

템플릿을 서명 요청 API 와 같은 엔드포인트를 사용하며 사전 준비로는 열람용 템플릿 생성, 추가 내용 입력을 위한 데이터 라벨 설정, 그리고 템플릿 ID 확인이 필요합니다.

1. 열람용 템플릿 생성하기


템플릿으로 서명 요청하기 API를 이용하기위해서는 먼저 열람용 템플릿을 설정해야합니다.
템플릿은 모두싸인 웹서비스에 로그인하여 생성할 수 있습니다.
템플릿 이용방법 바로가기

🚧

열람 요청의 역할 값(role)은 ‘열람자’로 설정됩니다.



2. 추가내용 입력 데이터 라벨 설정하기

템플릿으로 서명 요청하기 API 를 통해서 템플릿의 추가내용 입력을 수정할 수 있습니다.

특정 추가내용 입력란에 어떤 정보를 입력할 것인지를 데이터 라벨를 통해 지정할 수 있습니다.

데이터 라벨 은 템플릿 수정 페이지에서 나타나는 메뉴에서 확인 및 수정할 수 있습니다.

  • 텍스트를 클릭하면 오른쪽 상단에 데이터 라벨 에서 설정할 수 있습니다.

📘

API 기능 이용이 허용된 사용자에게만 제공됩니다.

API 기능 이용에 대한 문의는 모두싸인 고객센터를 통해 문의해 주세요.



3. 템플릿 ID 확인하기

열람요청의 기능을 사용위해서는 요청에 사용할 템플릿의 ID가 필요합니다. 템플릿의 ID는 템플릿 리스트 조회 API를 이용해 확인하거나, 템플릿 수정하기 페이지의 주소창에서 확인하실 수 있습니다.


4. 템플릿으로 열람요청

템플릿으로 서명 요청 API 로 요청을 보냅니다.
아래의 샘플코드를 클릭해 샘플코드와 설명을 확인해보세요.

🙋‍♀️
샘플코드 바로가기(열람요청) >
Open Recipe

👍

더 자세한 API 내용은 API References에서 확인하세요!

API References 의 "템플릿으로 서명 요청" API의 자세한 내용을 확인하세요.



내용 변경없이 참여자(열람자)만 변경하여 요청하기

템플릿에 설정된 값에서 참여자만 변경하여 요청합니다.
열람용 템플릿이 role은 '열람자'로 요청주셔야 합니다.

const body = {
    templateId: '{TEMPLATE_ID}',
    document: {
      title: '2024_확인서_홍길동',
      participantMappings: [
        {
          role: '열람자',
          name: '김모두',
          signingMethod: {
            type: 'EMAIL', 
            value: '[email protected]'
          }
        }
      ]
    }
};

참여자(열람자)에게 추가 인증 적용하기

참여자에게 추가 인증을 적용합니다.

const body = {
    templateId: '{TEMPLATE_ID}',
    document: {
      title: '2024_확인서_홍길동',
      participantMappings: [
        {
          role: '열람자',
          name: '김모두',
          signingMethod: {
            type: 'EMAIL', 
            value: '[email protected]'
          },
          verification: {
            password: { value: '1234' },
            mobileIdentification: { name: '김모두', phoneNumber: '01012345678' },
            dCert : {  name : '모두싸인',  'bizNumber': '1231212315'}
          },
      ]
    }
};

추가내용 입력을 동적으로 적용하기

템플릿에 설정된 추가내용 입력의 커스텀 ID에 입력값을 적용합니다.

const body = {
    templateId: '{TEMPLATE_ID}',
    document: {
      title: '2024_확인서_홍길동',
      participantMappings: [
        {
          role: '열람자',
          name: '김모두',
          signingMethod: {
            type: 'EMAIL', 
            value: '[email protected]'
          }
        }
      ],
      requesterInputMappings: [
        { dataLabel: '주소', value: '서울특별시 마포구 123-5번지' }, 
        { dataLabel: '동의', value: true }
      ]
    }
};

자주하는 질문(FAQ)

기존 템플릿과 열람용 템플릿이 따로 이용해서 사용해야하는건요?

네, 열람요청 기능을 이용하려면 열람용 템플릿을 만들어주셔서 템플릿 서명요청 API 를 호출해주셔야 합니다.

열람요청 기능에서 서명수단 보안링크 방법은 이용이 가능한가요?

현재는 열람요청 기능에서 서명수단의 보안링크 수단은 지원하지 않습니다.

템플릿 사용하지 않고 열람요청이 가능한가요?

현재는 템플릿을 사용하지 않고 ,서명요청 API 처럼 요청 값에 데이터를 담아 문서를 생성하는 API 기능을 지원하지 않습니다.
다만, 임베디드 기능을 활용하면 요청자가 파일을 업로드하여 열람 문서를 발송할 수 있습니다.

Updated 2 days ago