문서 리스트 조회 API 필터에 마지막 활동일(updatedAt) 조건이 추가되었습니다.
필터로 검색하기가 어떤 기능인지 궁금하신 분은 filter로 검색하기를 확인해 보세요.
문서 리스트를 API를 통해 조회 시 정렬 기능이 추가되었습니다.
📌 정렬 기능은 orderBy 속성을 통해 이용하실 수 있습니다.
📌 정렬 가능 필드는 문서 제목, 문서 생성일, 마지막 활동일이 제공됩니다.
📌 정렬 기준은 오름차순, 내림차순이 제공됩니다.
정렬 기능이 궁금하신 분은 orderBy로 정렬하기를 확인해 보세요.
참조자 리스트를 조회 할 수 있습니다.서명 요청 시 설정한 참조자 정보를 설정 한 후 해당 정보를 API 를 통해 확인할 수 있는 부분이 없었지만, 문서 상세 조회에 해당 속성이 추가 되어 확인할 수 있도록 제공 됩니다. ( carbonCopies)
응답 유형은 아래와 같으며, contact 항목이 제공 됩니다.
{
"carbonCopies": [
{
"contact": "01000000000"
},
{
"contact": "[email protected]"
}
]
}
기존 폴더 기능이 라벨로 대체기존에 사용하던 폴더 기능이 라벨로 대체 되며 폴더 관련 속성들은 일정 기간이 지난 후 제거 됩니다.
라벨 기능이 궁금하시면 "라벨을 만들어 분류하기" 를 참고해주세요
📌 서명요청, 템플릿으로 서명요청 시 사용하던 folderId는 이제 labelIds으로 대체 됩니다.
📌 folderId는 하나의 폴더를 지정했지만, labelIds는 복수개(최대 5개)의 라벨 설정이 가능 합니다.
📢 기존에 folderId를 사용하고 계셨다면 labelIds속성을 사용할 수 있도록 변경을 권장드리며, 신규로 라벨 기능을 사용하시려면 labelIds속성을 활용해주세요!
SCHEDULED가 추가 되었습니다.
예약전송 이란?원하는 시간에 서명 요청이 전송되도록 예약할 수 있는 기능이며 모두싸인 플랫폼에서 이용 가능합니다. 예약 전송 기능이 궁금하시면 "예약 전송 기능 소개"를 참고해주세요
📌 모두싸인 플랫폼 기능과 API 기능을 함께 사용할 경우, 플랫폼에서 예약 전송 등록 시 API 에서는 해당 문서가 SCHEDULED 상태로 조회 됩니다.
서명자 추가인증 정보를 조회 할 수 있습니다.서명 요청 시 설정한 서명자의 추가 인증 정보를 설정 한 후 해당 정보를 API 를 통해 확인할 수 있는 부분이 없었지만, 문서 상세 조회에 해당 속성이 추가 되어 확인할 수 있도록 제공 됩니다. ( participants -> verification)
응답 유형은 아래와 같으며, password, mobileIdentification, dCert 중 설정 된 항목만 제공 됩니다.
⚠️ 패스워드의 경우 보안상의 이유로 설정값은 제공하지 않으며 힌트만 제공합니다.
"verification": {
"password": {
"hint": "대한민국 1등 전자계약 서비스는?"
}
"mobileIdentification": {
"name": "김모두",
"phoneNumber": "01000000000"
},}
"dCert": {
"name": "모두싸인",
"bizNumber": "1234567890"
}
}웹훅을 통해 모두싸인에서 발생하는 이벤트를 사용자가 지정한 특정 URL로 POST 요청받을 수 있습니다.
이럴때 사용하세요!서명요청 시작부터 서명완료 과정에서 문서의 상태 변경 발생 시 고객사에서 운영중인 시스템의 특정 작업이 수행되어야 할 때(관리하고 있는 데이터의 상태 변경, 알림 전송 등), 모두싸인에서 발송하는 웹훅 이벤트를 받아 처리할 수 있습니다.
웹훅 기능에 대해 궁금하시면 Webhook 설정을 확인해 보세요
웹훅은 그동안 모두싸인 플랫폼 내에서 설정이 가능하며 많이 이용하고 계시는 기능 중 하나 입니다. API 로 제공되는 웹훅은 아래와 같은 상황에서 활용하기 더욱 좋습니다.
아래와 같은 상황에서 Webhook은 호출 실패로 판단하고 재시도(총 5회)를 시도 하도록 합니다.200번대 응답이 아닐 경우
10초 이내에 응답이 오지 않을 경우Webhook event 수신 후 내부적으로 어떤 로직을 수행하는데 있어 10초 이상 지연 될 수 있다면, timeout 으로 인해 재전송 될 수 있으니, Webhook event 수신 시 응답을(200번대 응답) 먼저 회신 후 내부 작업을 진행해주시는 것을 권장 드립니다.
구독할 수 있는 웹훅 이벤트 종류는 아래와 같습니다.
전달되는 이벤트 인터페이스 아래와 같습니다.
{
"event": {
"type": "{EVENT_TYPE}"
},
"document": {
"id": "{DOCUMENT_ID}",
"requester": {
"email": "{REQUESTER_EMAIL}"
}
}
}
계약서를 발송할 때, 관련 서류를 업로드할 수 있는 ‘서명 요청 시 파일 첨부’ 기능이 업데이트 되었습니다. 계약을 뒷받침해주거나 서명(계약 체결) 시 고지 또는 안내가 필요한 서류를, 서명 요청 단계에서 즉시 첨부하여 계약서와 함께 발송할 수 있게 되었습니다.
이럴때 사용하세요!고정 된 형식의 첨부파일의 경우 템플릿에 미리 설정해두고 서명 요청을 할 수 있습니다.
요청자 첨부파일 API는 서명 요청 마다 첨부해야 할 파일이 변경되어야 할 경우에 활용을 권장 합니다.서명 요청시 파일첨부 기능에 대해 궁금하시면 서명 요청시 파일첨부 업데이트를 확인해 보세요
파일을 첨부하기 위해서는 아래와 같이 파일 정보(fileId, token, name) 가 필요 합니다.
해당 파일 정보는 이번에 같이 추가 된 파일 업로드 API 를 통해 획득 가능 합니다.
파일 업로드는 다른 API 와 달리 Contents-Type 이 "multipart/form-data" 으로 요청이 필요하며 binary 형식의 파일을 Stream 을 통해 업로드 후 해당 파일에 대한 정보를 반환 합니다. 파일 개당 10MB 까지 업로드 가능하며 토큰의 유효시간은 2시간 입니다. 서명 요청 시 첨부하려는 파일을 파일 업로드 API 를 통해 업로드 후 받은 정보들을 이용해 이어서 서명 요청을 진행하는 방식으로 이용할 수 있습니다.
해당 기능이 적용 된 API 는 아래와 같습니다.
API에 참조자 기능이 추가되었습니다. 참조자 기능은 참조자(cc)를 최대 10명까지 설정 가능하며 설정 된 참조자의 이메일 혹은 휴대폰 번호(카카오톡)로 서명 시작 및 서명 완료 알림을 받을 수 있도록 합니다. 해당 기능이 적용되는 API 목록은 아래와 같으며 carbonCopies속성을 이용해 사용하실 수 있습니다.
참조자 기능 소개참조자 기능에 대해 궁금하시면 고객센터 FAQ를 확인해 보세요
템플릿을 만들지 않고 직접 문서를 생성하는 API가 추가되었습니다. 요청자 입력, 참여자 필드의 위치와 크기 등의 정보를 모두 직접 설정할 수 있습니다. 템플릿이 자주 변경되는 경우라면 편리하게 사용할 수 있습니다.
기존에 메타데이터를 등록하기 위해서는 문서 혹은 템플릿 생성 후 메타데이터 수정 API를 통해 별도로 등록 해야했습니다. 이번 패치로 문서 생성, 템플릿 생성 등 아래의 API에 대해서 메타데이터 정보를 함께 요청 할 수 있도록 개선 되었습니다. 🌈
이제 클라우드 앱에서 지원하는 "순서없이 서명하기" 기능을 API로 요청하실 수 있습니다. 참여자의 signingOrder를 모두 1로 설정하면, 다수의 참여자가 함께 서명하고자 할 때 순서를 기다리지 않고 함께 서명할 수 있습니다.
초안 생성 후 클라우드에서 직접 요청자 입력, 참여자 필드를 추가하는 수고없이 초안을 만들 때 미리 지정할 수 있게 되었습니다. 👏🏼
자세한 사용방법은 API 레퍼런스를 확인해 보세요.