네, 가능합니다. 모두싸인은 REST API로 서비스 연동이 가능하므로, 네트워크 통신만 되는 환경이라면 어떠한 플랫폼과도 연동이 가능합니다.
다만, 이용 중이신 외부 플랫폼에 연동이 필요하신 경우 플랫폼 운영사 측과 기술 연동 가능 여부 등에 확인 과정이 필요할 수 있습니다.
네, 가능합니다. 모두싸인은 REST API로 서비스 연동이 가능하기에, 워드프레스에서도 코드를 커스텀 할 수 있다면 연동이 가능합니다.
REST API로 워드프레스에 실시간으로 외부 컨텐츠를 사내 웹사이트로 가져오는 방법은 우측 링크를 통해 확인하실 수 있습니다. (링크 >)
각 계정별로 모두싸인 계정에서 API 호출을 위한 Key를 발급할 수 있습니다.
대다수의 고객사는 하나의 루트 계정을 통해 API를 연동하며, 마스터 계정(루트 계정)에서 Key를 발급받아 전자 계약 서비스 단위로 연동하게 됩니다.
보다 구체적인 문의사항이 있거나 API 기능 이용을 희망하신다면, 서비스 우측 하단에 있는 채팅 버튼을 눌러 문의해 주세요.
모두싸인 워크스페이스 별로 전체 사용량을 확인할 수 있습니다. [사용량 조회 API]를 통한 워크스페이스 사용량을 확인할 수 있습니다. (사용량 조회 API>)
[임베디드 초안 생성] 또는 [템플릿으로 임베디드 초안 생성] API로만 가능합니다.
API 호출시 바디에서 확인되는 임베디드 URL에 “&mode=preview”를 붙이면 PDF 형태로 데이터가 모두 들어간 문서 초안을 바로 확인하실 수 있습니다.
미리보기 모드에서는 문서에 추가 내용 입력이 입력되었을 때의 모습을 확인할 수 있으며, 서명 요청 기능은 비활성화됩니다.
현재 대량전송 API는 지원하지 않습니다.
따라서 다량의 문서를 발송(서명 요청)하고자 하시는 경우, 수신자에게 발송할 템플릿 및 참여자 정보를 활용하여 여러 번 자동 발송이 되는 구조로 추가 개발이 필요합니다.
• EX) 500명에게 API를 통해 대량전송을 보낼 경우 -> 500명의 서명자 정보 활용하여 해당 API를 500번 자동발송되도록 구현 부탁드립니다.
네, 가능합니다. [서명 요청 알림 재전송 API]를 통해 문서 ID로 알림 재전송할 수 있습니다.
만약 알림 재전송이 일정한 주기에 따라 자동으로 작동하도록 구현하고자 하시는 경우에는 아래 방법으로 이용이 가능합니다.
[문서 리스트 조회 API]로 리스트 불러오기
‘ON_GOING’ 중인 문서로 조회
해당 API가 리턴하는 문서 ID를 활용하여 [서명요청 알림 재전송 API] 호출
Webhook(웹훅)이란, 서버에서 어떠한 작업이 수행 되었을 때 해당 작업이 수행되었음을 HTTP POST로 알리는 개념을 말합니다.
자세한 웹훅 설정 및 활용 방법은 우측 매뉴얼 확인하기를 통해 알아보실 수 있습니다. (매뉴얼 확인하기 >)
네 맞습니다. 현재 웹훅은 모든 이벤트에서 문서 ID와 서명요청자 이메일만 제공되고 있습니다.
이때 추가로 문서 이름이나 기타 정보가 필요할 경우 문서 ID를 이용해 [문서상세 조회 API]를 이용하여 추가적인 정보를 획득하실 수 있습니다.
네, 아래 절차를 참고하시어 구현이 가능합니다.
(1) Webhook 수신: 문서 ID 획득
(2) 문서 상세 조회 API 호출
(3) 문서 상세 정보 API 리턴 body문서의 상태, 중단 정보(중단 종류, 사유, 시점, 서명자 ID 등) 등을 확인
아래와 같은 상황에서 웹훅은 호출 실패로 판단하고 재시도(총 5회)를 진행합니다.
200번대 응답이 아닐 경우
10초 이내에 응답이 오지 않을 경우
아래의 경우는 재시도 했을 때 성공 전활율이 낮거나, 의도하지 않은 중복 작업을 발생시킬 가능성 있으므로 재시도 하지 않습니다.
401, 404 응답을 반환환 경우
응답에 10초 이상이 소요되는 경우(timeout)
웹훅 사용 시 웹훅 응답을(200번대 응답) 먼저 회신 후 내부 로직 작업을 진행해주시는 것을 권장 드립니다.
404에러는 여러가지 이유로 발생 가능하기 때문에 해당 API 호출 시 데이터 값이 정상적으로 입력되었는지 확인 요청드립니다. (문서 ID, 템플릿 ID, Username 등)
각종 확인 이후에도 문제가 발생할 경우, 우측 하단의 문의하기 버튼 혹은 아래 문의하기 링크 클릭 후 "개발 중 문의"를 눌러 언어 환경 / 에러 / 사용하신 모듈 / 오류 화면 캡처 내용을 전달주시면 확인 도와드리겠습니다. (문의하기 >)
※[]
는 숫자가 requesterInputMappings
에서 몇 번째 순서냐에 따라서 바뀔 수 있음
해당 메시지의 내용은 다음과 같은 오류 일 때 발생합니다.
이미지파일
이미지 파일이 3mb를 초과하는 경우
확장자 파일이 .jpg, .jpeg, .png 아닌 파일
이미지 파일이 base64로 인코딩 될 때 변환된 텍스트가 짤려서 발생하는 현상(회사 내부 코드 문제)
syntax 오류
requesterInputMappings
의value
값이 텍스트임에도 문자열(String) 형식의 큰따옴표(" ")를 넣지 않아 발생한 오류
해당 메시지는 요청자 필드 매핑 정보에 서명자 필드 라벨 사용 시 발생하는 오류입니다.
API를 통해 동적으로 데이터를 삽입하려면 '문서편집 필드'를 사용해야 하며, 서명자 필드는 서명자가 서명 시 직접 입력하는 필드이기 때문에 API로는 미리 값을 채울 수 없습니다.
추가입력(requesterInputMappings) 내에 사용하는 데이터 라벨 중에 혹시 서명자 필드가 있는 것은 아닌지 확인해주세요.
해당 메시지는 템플릿에 정의된 서명자 수/역할과 API 요청 시 보낸 서명자 수/역할이 일치하지 않아 발생하는 오류입니다.
설정된 템플릿 Role의 수와 역할 이름을 동일하게 전부 추가하였는지 확인해주세요.
해당 메시지는 보내시는 요청값과 템플릿에 있는 문서 편집 데이터 라벨이 상이할 때 발생하는 오류입니다.
requesterInputMappings
에서 dataLabel
은 템플릿에 정의된 '요청자(문서편집) 입력란'의 데이터라벨과 정확히 일치해야 하며, 매핑하려는 필드만 포함해야 합니다.
dataLabel
값을 잘못 사용하거나, 템플릿에 없는 dataLabel
을 사용하신 것은 아닌지 확인해주세요.
labelIds
과dataLabel
의 차이labelIds
파라미터는 문서 자체에 라벨을 붙여 분류하는 기능이고,dataLabel
은 템플릿내 요청자(문서편집)/참여자 입력란의 명칭을 분류하는 기능입니다.템플릿의 데이터 라벨은 템플릿 수정 화면에서 설정할 수 있습니다.
데이터라벨을 설정할 때 API 연동을 고려하여 특수문자 없이 명확한 이름 사용을 권장합니다.
해당 메시지는 API 요청 시 요청 header에 인증정보 설정이 되어있지 않거나 문제가 있을 때 발생하는 오류입니다.
API KEY 를 이용하시고 계시다면 API 요청 시 Authorization 헤더에 Basic 스킴으로 전달 주셔야 하며 ${사용자 이메일:API KEY} 이와 같은 형태로 조합 후 Base64 로 인코딩 후 전달 주셔야 합니다.
자세한 내용 확인은 API KEY로 요청하기 안내 참고 부탁드리며, API 레퍼런스 페이지 우측에 캡쳐 사진과 같이 입력 후 하단의 예제코드에서 Authorization 헤더 정보를 확인 해보실 수 있습니다.
OAuth 연동하여 access-token을 발급받아서 활용하고 계신다면 OAuth 액세스 토큰 사용하기 페이지를 참고해주세요.