DocsReferencesChangelog
Docs

임베디드 문서 열람

임베디드 문서 열람은 유저가 접근 가능한 문서를 모두싸인 문서 열람 페이지를 통해 확인할 수 있는 기능입니다.
또한 해당 문서가 유저가 현재 서명 가능한 문서라면, 임베디드 URL에 &signable=true를 추가하여 서명 입력도 가능합니다.

문서 임베디드 URL 가져오기

임베디드 문서 열람을 위해서는 임베디드 문서 보기 URL 조회 API를 이용합니다.
API의 path에 열람하고자 하는 문서의 id를 포함해 요청합니다.

요청하기

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'

응답 Body

{
  "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...';

 

서명 입력

해당 문서가 유저가 현재 서명 가능한 문서라면, 임베디드 URL에 &signable=true를 추가하여 서명을 입력할 수 있는 페이지를 열 수 있습니다.

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

Updated 11 months ago