임베디드 문서 열람 기능을 통해 사용자는 모두싸인 문서 열람 페이지에서 접근 가능한 모든 문서를 확인할 수 있습니다. 서명 가능한 문서의 경우, 임베디드 URL에 &signable=true 파라미터를 추가하여 문서 열람과 함께 서명 입력까지 가능합니다.

임베디드 URL 발급오기

임베디드 문서 열람을 시작하려면 먼저 임베디드 문서 보기 URL 조회 API를 호출하여 임베디드 URL을 발급받아야 합니다.

Requst

curl --request GET \
  --url https://api.modusign.co.kr/documents/DOCUMENT_ID/embedded-view \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic {인코딩된 API-KEY}' \
  --header 'Content-Type: application/json'

Response

{
  "embeddedUrl":"https://app.modusign.co.kr/embedded-document/XXX?at=XXXXXXX..."
}

API 요청의 응답 예시는 위와 같습니다.
응답의 embeddedUrl 에는 접속 가능한 URL이 전달됩니다. 해당 URL은 2시간 동안만 유효합니다.

❗️
HTTP API를 클라이언트에서 호출하지 마세요!
API 호출에 사용되는 API KEY는 유저의 권한을 획득하는 민감한 데이터입니다.
클라이언트에 KEY를 노출해서는 안 되며, 서버 사이드에서 보호되어야 합니다.

2. 임베디드 URL 열기

해당 URL을 클라이언트로 전달하여, 새 창, 새 탭 또는 iframe 내에서 열 수 있습니다.

클라이언트 사이드

// 새탭으로 열기
window.open("https://app.modusign.co.kr/embedded-document/XXX?at=XXXXXXX...");

// 새창으로 열기
window.open(
  'https://app.modusign.co.kr/embedded-document/XXX?at=XXXXXXX...',
  '_blank', 
  'top=10, left=10, width=1440, height=900'
);

// iframe에 열기
var targetIframe = document.getElementById('target-iframe');
targetIframe.src = 'https://app.modusign.co.kr/embedded-document/XXX?at=XXXXXXX...';

3. 서명 가능한 문서 열기

현재 사용자가 서명 또는 열람 권한을 가진 문서의 경우, 임베디드 URL에 &signable=true 파라미터를 추가하여 서명 입력이 가능한 페이지로 열 수 있습니다.

// 서명 입력 페이지로 열기
const embeddedUrl = "https://app.modusign.co.kr/embedded-document/XXX?at=XXXXXXX...";
window.open(embeddedUrl + "&signable=true");

📘
서명 권한 확인
서명 입력 페이지를 열기 위해서는 해당 문서에 대한 서명자의 API Key 또는 Token으로 임베디드 URL을 발급받아야 합니다. 서명 권한이 없는 사용자가 signable=true 파라미터로 접근하면 열람 전용 페이지가 표시됩니다.