API 연동 자주 묻는 질문
API 연동, Webhook(웹훅) 등 API와 관련된 문의는 FAQ를 참고해 주세요.
네, 가능합니다. 모두싸인은 REST API로 서비스 연동이 가능하므로, 네트워크 통신만 되는 환경이라면 어떠한 플랫폼과도 연동이 가능합니다.
다만, 이용 중이신 외부 플랫폼에 연동이 필요하신 경우 플랫폼 운영사 측과 기술 연동 가능 여부 등에 확인 과정이 필요할 수 있습니다.
네, 가능합니다. 모두싸인은 REST API로 서비스 연동이 가능하기에, 워드프레스에서도 코드를 커스텀 할 수 있다면 연동이 가능합니다.
REST API로 워드프레스에 실시간으로 외부 컨텐츠를 사내 웹사이트로 가져오는 방법은 우측 링크를 통해 확인하실 수 있습니다. (링크 >)
마스터 계정(루트 계정) 발급하여 기능들을 호출하는 KEY 값을 연동합니다.
연동 후에는 각 기능별로 API 호출이 가능합니다.
[사용량 조회 API]를 통해 계정별 사용량을 확인할 수 있습니다. (사용량 조회 API>)
[임베디드 초안 생성] 또는 [템플릿으로 임베디드 초안 생성] API로만 가능합니다.
API 호출시 바디에서 확인되는 임베디드 URL에 “&mode=preview”를 붙이면 PDF 형태로 데이터가 모두 들어간 문서 초안을 바로 확인하실 수 있습니다.
미리보기 모드에서는 문서에 추가 내용 입력이 입력되었을 때의 모습을 확인할 수 있으며, 서명 요청 기능은 비활성화됩니다.
현재 대량전송 API는 지원하지 않습니다.
따라서 다량의 문서를 발송(서명 요청)하고자 하시는 경우, 수신자에게 발송할 템플릿 및 참여자 정보를 활용하여 여러 번 자동 발송이 되는 구조로 추가 개발이 필요합니다.
• EX) 500명에게 API를 통해 대량전송을 보낼 경우 -> 500명의 서명자 정보 활용하여 해당 API를 500번 자동발송되도록 구현 부탁드립니다.
네, 가능합니다. [서명 요청 알림 재전송 API]를 통해 문서 ID로 알림 재전송할 수 있습니다.
만약 알림 재전송이 일정한 주기에 따라 자동으로 작동하도록 구현하고자 하시는 경우에는 아래 방법으로 이용이 가능합니다.
(1) [문서 리스트 조회 API]로 리스트 불러오기 (2) '상대 서명 대기중'인 문서만 조회 (3) 해당 API가 리턴하는 문서 ID를 활용하여 [서명요청 알림 재전송 API] 호출
Webhook(웹훅)이란, 서버에서 어떠한 작업이 수행 되었을 때 해당 작업이 수행되었음을 HTTP POST로 알리는 개념을 말합니다.
자세한 웹훅 설정 및 활용 방법은 우측 매뉴얼 확인하기를 통해 알아보실 수 있습니다. (매뉴얼 확인하기 >)
네 맞습니다. 현재 웹훅은 모든 이벤트에서 문서 ID와 서명요청자 이메일만 제공되고 있습니다.
이때 추가로 문서 이름이나 기타 정보가 필요할 경우 문서 ID를 이용해 [문서상세 조회 API]를 이용하여 추가적인 정보를 획득하실 수 있습니다.
네, 아래 절차를 참고하시어 구현이 가능합니다.
(1) Webhook 수신: 문서 ID 획득
(2) 문서 상세 조회 API 호출
(3) 문서 상세 정보 API 리턴 body문서의 상태, 중단 정보(중단 종류, 사유, 시점, 서명자 ID 등) 등을 확인
아래와 같은 상황에서 웹훅은 호출 실패로 판단하고 재시도(총 5회)를 진행합니다.
200번대 응답이 아닐 경우
10초 이내에 응답이 오지 않을 경우
특정 문서에서 3번의 재시도, 즉 10초 이상 소요되어 timeout으로 인한 재시도가 일어날 수 있습니다.
웹훅 사용 시 웹훅 응답을(200번대 응답) 먼저 회신 후 내부 로직 작업을 진행해주시는 것을 권장 드립니다.
404에러는 여러가지 이유로 발생 가능하기 때문에 해당 API 호출 시 데이터 값이 정상적으로 입력되었는지 확인 요청드립니다. (문서 ID, 템플릿 ID, Username 등)
각종 확인 이후에도 문제가 발생할 경우, 우측 하단의 문의하기 버튼 혹은 아래 문의하기 링크 클릭 후 "개발 중 문의"를 눌러 언어 환경 / 에러 / 사용하신 모듈 / 오류 화면 캡처 내용을 전달주시면 확인 도와드리겠습니다. (문의하기 >)