템플릿으로 서명 요청하기
템플릿으로 서명 요청 API는 이용자의 계정에 설정되어 있는 템플릿을 기반으로 일부 추가 정보를 전달하여 모두싸인 전자계약을 시작하고 참여자에게 서명요청 알림을 발송하는 기능입니다.
템플릿으로 서명 요청 API를 이용하기 위해서는 사전준비로 템플릿 생성, 참여자 역할 설정, 추가내용 입력의 데이터 라벨 설정, 템플릿 ID 확인이 필요합니다.
1. 템플릿 생성하기
템플릿으로 서명 요청하기 API를 이용하기위해서는 먼저 템플릿을 설정해야합니다.
템플릿은 모두싸인 웹서비스에 로그인하여 생성할 수 있습니다.
템플릿 이용방법 바로가기
2. 참여자의 역할 설정하기
템플릿 생성에서 참여자의 역할을 지정합니다.
참여자의 역할은 참여자의 이름, 이메일, 전화번호, 추가 인증, 남길 말, 서명 유효 기간 등을 설정하는데 이용됩니다.
3. 추가내용 입력 데이터 라벨 설정하기
템플릿으로 서명 요청하기 API 를 통해서 템플릿의 추가내용 입력과 첨부파일 요청을 수정할 수 있습니다.
특정 추가내용 입력란에 어떤 정보를 입력할 것인지를 커스텀 ID를 통해 지정할 수 있습니다.
특정 첨부파일 요청을 서명요청에서 제외시키거나, 필수 여부를 변경할 수도 있습니다.
커스텀 ID 는 템플릿 수정 페이지에서 나타나는 메뉴에서 확인 및 수정할 수 있습니다.
-
추가내용 입력을 클릭합니다.
-
첨부파일 요청 버튼을 클릭합니다.
API 기능 이용이 허용된 사용자에게만 제공됩니다.
API 기능 이용에 대한 문의는 모두싸인 고객센터를 통해 문의해 주세요.
4. 템플릿 ID 확인하기
템플릿으로 서명 요청하기 API 의 사용을 위해서는 요청에 사용할 템플릿의 ID가 필요합니다.
템플릿의 ID는 템플릿 리스트 조회 API를 이용해 확인하거나, 템플릿 수정하기 페이지의 주소창에서 확인하실 수 있습니다.
5. 템플릿으로 서명요청
템플릿으로 서명 요청 API 로 요청을 보냅니다.
아래의 샘플코드를 클릭해 샘플코드와 설명을 확인해보세요.
더 자세한 API 내용은 API References에서 확인하세요!
API References 의 "템플릿으로 서명 요청" API의 자세한 내용을 확인하세요.
내용 변경없이 참여자만 변경하여 요청하기
템플릿에 설정된 값에서 참여자만 변경하여 요청합니다.
const body = {
templateId: '{TEMPLATE_ID}',
document: {
title: '2020_근로계약서_홍길동',
participantMappings: [
{
role: '근로자',
name: '김모두',
signingMethod: {
type: 'EMAIL',
value: '[email protected]'
}
}
]
}
};
특정 참여자를 요청에서 제외하기
템플릿에 설정된 참여자중 해당 요청에서 제외할 참여자를 지정합니다.
const body = {
templateId: '{TEMPLATE_ID}',
document: {
title: '2020_근로계약서_홍길동',
participantMappings: [
{
role: '근로자',
name: '김모두',
signingMethod: {
type: 'EMAIL',
value: '[email protected]'
}
},
{
role: '근로자2',
excluded: true,
}
]
}
};
참여자에게 추가 인증 적용하기
참여자에게 추가 인증을 적용합니다.
const body = {
templateId: '{TEMPLATE_ID}',
document: {
title: '2020_근로계약서_홍길동',
participantMappings: [
{
role: '근로자',
name: '김모두',
signingMethod: {
type: 'EMAIL',
value: '[email protected]'
},
verification: {
password: { value: '1234' },
mobileIdentification: { name: '김모두', phoneNumber: '01012345678' },
}
}
]
}
};
추가내용 입력을 동적으로 적용하기
템플릿에 설정된 추가내용 입력의 커스텀 ID에 입력값을 적용합니다.
const body = {
templateId: '{TEMPLATE_ID}',
document: {
title: '2020_근로계약서_홍길동',
participantMappings: [
{
role: '근로자',
name: '김모두',
signingMethod: {
type: 'EMAIL',
value: '[email protected]'
}
}
],
requesterInputMappings: [
{ dataLabel: '주소', value: '서울특별시 마포구 123-5번지' },
{ dataLabel: '동의', value: true }
]
}
};
첨부파일의 필수 및 포함 여부를 동적으로 수정하기
템플릿에 설정된 첨부파일 요청의 커스텀 ID 필수 및 포함 여부를 수정합니다.
excluded 는 true값을 적용해 해당 첨부파일 요청을 서명요청시 제외시킬 수 있습니다.
required 는 해당 첨부파일 요청의 필수 첨부 여부를 수정합니다.
const body = {
templateId: '{TEMPLATE_ID}',
document: {
title: '2020_근로계약서_홍길동',
participantMappings: [
{
role: '근로자',
name: '김모두',
signingMethod: {
type: 'EMAIL',
value: '[email protected]'
},
attachmentRequests: [
{ dataLabel: '사업자등록증 사본', excluded: true },
{ dataLabel: '주민등록증 사본', required: false },
{ dataLabel: '통장 사본', required: true }
],
locale: 'ko'
}
]
}
};
Updated 9 days ago