방수 기호(미리 보기)
Sproof Sign을 사용하여 PDF 및 DOCX 문서에 대한 안전한 전자 서명 워크플로를 자동화합니다. 조직은 단일 또는 다중 문서 서명 요청을 만들고, 받는 사람 및 서명 역할을 할당하고, 상태를 추적하고, 완료된 PDF를 다운로드하고, 문서를 삭제할 수 있습니다. 방수 서명 계정, 선택한 작업 및 서명 유형을 지원하는 계획 및 유효한 API 토큰이 필요합니다.
이 커넥터는 다음 제품과 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | Regions |
|---|---|---|
| Copilot Studio | Premium | 다음을 제외한 모든 Power Automate 지역: - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 논리 앱 | 표준 | 다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD) |
| Power Apps | Premium | 다음을 제외한 모든 Power Apps 지역: - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 파워 오토메이트 | Premium | 다음을 제외한 모든 Power Automate 지역: - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| Contact | |
|---|---|
| 이름 | API 지원 |
| URL | https://sproof.com |
| 전자 메일 | support@sproof.com |
| 커넥터 메타데이터 | |
|---|---|
| Publisher | Sproof GmbH |
| 웹 사이트 | https://www.sproof.com/en/sign/ |
| 개인 정보 보호 정책 | https://www.sproof.com/en/privacy-policy-app/ |
| 카테고리 | 생산력; 콘텐츠 및 파일 |
방수 기호
개요
Sproof Sign을 사용하면 조직에서 PDF 및 DOCX 문서에 대한 전자 서명 워크플로를 자동화할 수 있습니다. 커넥터는 단일 문서 서명 요청 또는 다중 문서 봉투를 만들고, 받는 사람 및 서명 역할을 할당하고, 요청 상태를 검색하고, 완료된 문서를 다운로드하고, 문서를 삭제할 수 있습니다.
필수 조건
커넥터를 사용하려면 다음이 필요합니다.
- 방수 서명 계정입니다.
- API 액세스 및 필요한 작업 및 서명 유형에 대한 지원이 포함된 방수 서명 계획입니다.
- 유효한 Sproof Sign API 토큰입니다.
Authentication
커넥터는 API 토큰 인증을 사용합니다. 계정과 연결된 유효한 Sproof Sign API 토큰을 입력하여 연결을 만듭니다. 토큰이 해지되거나 다시 생성될 경우 토큰을 안전하게 유지하고 대체합니다.
지원되는 작업
- 서명 요청 만들기 - 하나의 문서 또는 여러 문서가 포함된 봉투에 대한 요청을 만듭니다. 받는 사람, 서명 역할, 서명 순서, 서명 위치 및 기타 초대 설정을 구성할 수 있습니다.
- 자리 표시자를 사용하여 서명 요청 만들기 - 업로드된 문서에 저장된 자리 표시자를 사용하여 요청을 만듭니다. 받는 사람 정보 및 서명 위치는 해당 자리 표시자에서 추출됩니다.
- 요청 상태 가져오기 - 해당 멤버 ID를 사용하여 서명 요청의 현재 상태 및 서명 상태를 검색합니다.
- 문서 가져오기 - 문서를 이진 PDF 또는 Base64로 인코딩된 PDF로 다운로드합니다.
- 문서 삭제 - 제공된 멤버 ID, 구성원의 역할 및 문서가 봉투에 속하는지 여부에 따라 문서를 삭제하거나 구성원의 액세스를 제거합니다.
알려진 제한 사항 및 요구 사항
- 입력 문서는 Base64로 인코딩된 PDF 또는 DOCX 콘텐츠로 제공해야 합니다.
- 봉투에는 최대 25개의 문서가 포함될 수 있습니다.
- 둘 이상의 문서를 제출할 때 봉투 이름이 필요합니다.
- 자리 표시자 기반 요청에는 업로드된 문서에서 올바르게 서식이 지정된 자리 표시자가 필요합니다.
- 자리 표시자 기반 요청의 경우 받는 사람 및 서명 위치는 수동으로 입력하지 않고 문서에서 가져옵니다.
- 사용 가능한 작업, 서명 유형 및 공급자는 연결된 방수 서명 계정 및 계획에 따라 달라집니다.
- 문서 삭제 동작은 제공된 멤버 ID가 보낸 사람 또는 받는 사람에 속하는지 여부와 문서가 봉투의 일부인지 여부에 따라 달라집니다.
Support
커넥터 또는 API 지원은 .에 문의하세요 support@sproof.com.
연결 생성
커넥터는 다음과 같은 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유 불가 |
기본값
적용 가능 지역: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유할 수 없는 연결입니다. Power App이 다른 사용자와 공유되는 경우, 다른 사용자에게는 명시적으로 새로운 연결을 생성하라는 메시지가 표시됩니다.
| 이름 | Type | Description | 필수 |
|---|---|---|---|
| token | 시큐어스트링 (보안 문자열) | "token" für diese API | True |
actions
| 문서 가져오기 |
서명된 문서를 이진 또는 Base64로 인코딩된 문자열로 가져옵니다. |
| 문서 삭제 |
제공된 봉투에 있는 문서 쿼리 매개 변수 보낸 사람
받는 사람
단일 문서 보낸 사람
보낸 사람
받는 사람
|
| 서명 요청 만들기 |
새 서명 만들기 요청입니다. 이제 단일 문서 초대를 만드는 것 외에도 초대를 보낼 때 봉투를 만들고 여러 문서를 한 번에 업로드할 수 있습니다. |
| 요청 상태 가져오기 |
서명 요청의 상태를 가져옵니다. 문서 JSON 개체 또는 오류를 반환합니다. 매개 변수는 문서의 게시 요청에 의해 반환되며 보낸 사람 전자 메일과 연결됩니다. |
| 자리 표시자를 사용하여 서명 요청 만들기 |
업로드된 문서에 저장된 자리 표시자를 사용하여 서명 요청을 만듭니다. 받는 사람 및 서명 위치는 문서에서 추출됩니다. |
문서 가져오기
서명된 문서를 이진 또는 Base64로 인코딩된 문자열로 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
멤버 ID
|
memberId | True | string |
멤버 ID |
|
다운로드 형식
|
format | string |
응답 형식을 지정합니다. 이진 PDF 및 |
반품
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
base64
|
base64 | string |
Base64로 인코딩된 PDF 콘텐츠 |
문서 삭제
제공된 memberId 문서가 보낸 사람 또는 받는 사람에 속하는지 여부와 문서가 봉투의 일부인지 여부에 따라 문서를 삭제하거나 구성원의 액세스 권한을 제거합니다.
봉투에 있는 문서
쿼리 매개 변수 all 는 봉투에 있는 문서에 영향을 주지 않습니다.
보낸 사람 memberId:
- 보낸 사람과 모든 받는 사람에 대해 단일 문서가 삭제됩니다.
- 문서가 봉투에서 제거됩니다.
받는 사람 memberId:
- 받는 사람에 대해 봉투에 있는 모든 문서가 제거됩니다.
- 받는 사람은 받는 사람에 대해 삭제된 모든 문서에 있는 것으로
declined표시됩니다. - 문서는 문서의 다른 모든 구성원에 대해 계속 사용할 수 있습니다.
단일 문서
보낸 사람 memberId 및 all=true:
- 보낸 사람과 모든 받는 사람에 대해 문서가 삭제됩니다.
보낸 사람 memberId 및 all=false:
- 문서는 보낸 사람만 삭제됩니다.
- 문서의 다른 받는 사람이 문서를 계속 사용할 수 있습니다.
받는 사람 memberId:
- 받는 사람이 문서에 표시된 것처럼
declined표시됩니다. - 문서는 문서의 다른 모든 구성원에 대해 계속 사용할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
멤버 ID
|
memberId | True | string |
멤버 ID |
|
모든 받는 사람에 대해 삭제
|
all | boolean |
제공된 |
반품
- response
- DeleteDocumentResponse
서명 요청 만들기
새 서명 만들기 요청입니다. 이제 단일 문서 초대를 만드는 것 외에도 초대를 보낼 때 봉투를 만들고 여러 문서를 한 번에 업로드할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
email
|
True | string |
보낸 사람의 전자 메일입니다. 계획의 멤버에 속해야 합니다. |
|
|
firstName
|
firstName | True | string |
보낸 사람의 이름입니다. |
|
lastName
|
lastName | string |
보낸 사람의 성입니다. |
|
|
role
|
role | string |
모든 문서에서 보낸 사람의 역할입니다. |
|
|
email
|
string |
받는 사람의 전자 메일입니다. |
||
|
firstName
|
firstName | string |
받는 사람의 이름입니다. |
|
|
lastName
|
lastName | string |
받는 사람의 성입니다. |
|
|
doNotSendEmails
|
doNotSendEmails | boolean |
전자 메일이 |
|
|
customId
|
customId | string |
받는 사람의 전자 메일 주소를 초대할 때 알 수 없는 경우에만 사용할 수 있습니다. 이는 받는 사람을 초대하고(경로 준비가 아님) fastlane을 사용하려는 경우에만 작동합니다. 그러면 참고: customId는 문서에 대한 받는 사람 링크를 작성하는 데만 사용할 수 있습니다. memberId 대신 다른 요청에는 사용할 수 없습니다. URL 생성에 대한 자세한 내용은 사용자 지정 ID를 사용하여 문서 열기를 참조하세요. |
|
|
useFastlane
|
useFastlane | boolean |
서명자에게 |
|
|
phoneNumber
|
phoneNumber | string |
이 받는 사람의 전화 번호입니다. SMS 확인에 사용됩니다. (예: +43 699 1234 1234). |
|
|
privateMessage
|
privateMessage | string |
이 특정 받는 사람에 대한 개인 메시지입니다. |
|
|
inPersonMode
|
inPersonMode | boolean |
이 옵션을 사용하도록 설정하면 서명 요청의 받는 사람이 직접 문서에 서명해야 하며 전자 메일이 전송되지 않습니다. 이 모드는 SES 서명 형식을 사용하여만 사용할 수 있습니다. |
|
|
signatureTypes
|
signatureTypes | array of string |
이 받는 사람에게 허용되는 서명 유형입니다. 옵션: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple'] |
|
|
tag
|
tag | string |
이 태그는 서명 프로세스에 사용할 ID 공급자를 결정합니다. 미리 정의된 지원되는 공급자 집합 중에서 선택합니다.
참고2: 기본 공급자로 사용하는 |
|
|
canChange
|
canChange | boolean |
초대된 받는 사람이 서명 공급자를 변경할 수 있는지 여부를 나타내는 부울 |
|
|
country
|
country | string |
기본 국가이며 비어 있는 경우 모두로 설정하면 선택한 공급자 태그에 사용할 수 있는 국가와 함께 오류가 반환됩니다. |
|
|
기한날짜
|
dueDate | YYYY-MM-DD |
문서에 서명할 수 있는 날짜입니다. 이 기한은 초대 전자 메일의 받는 사람에게 표시되며 대시보드의 문서 세부 정보 섹션에도 표시됩니다. 서명 프로세스를 완료하기 위한 마감일로 사용됩니다. |
|
|
reminderInterval
|
reminderInterval | number |
미리 알림 전자 메일 사이의 일 수를 지정합니다. |
|
|
startSendingReminders
|
startSendingReminders | YYYY-MM-DD HH:MM |
미리 알림을 보내야 하는 날짜 |
|
|
inviteLanguage
|
inviteLanguage | string |
계정이 없는 익명 사용자에게 보낸 전자 메일의 언어를 지정합니다. 계정이 있는 사용자의 경우 프로필에서 선택한 언어가 대신 사용됩니다. |
|
|
message
|
message | string |
전자 메일 내의 받는 사람에게 보낸 사용자 지정 메시지입니다. |
|
|
subject
|
subject | string |
받는 사람에게 보낸 전자 메일의 제목 줄입니다. |
|
|
sendOutFinishedPdf
|
sendOutFinishedPdf | boolean |
true로 설정하면 pdf가 문서의 모든 받는 사람에게 첨부 파일로 전송됩니다(5MB보다 작은 경우). |
|
|
focusedSigningMode
|
focusedSigningMode | boolean |
이 옵션을 사용하도록 설정하면 서명 요청의 받는 사람이 문서 서명 또는 거부로 제한되며 페이지에서 이동할 수 없습니다. |
|
|
allowForwarding
|
allowForwarding | boolean |
초대 전달을 허용합니다. |
|
|
collabSigningMode
|
collabSigningMode | object |
각 키가 서명 라운드를 나타내고 해당 값이 해당 라운드에 대해 공동 서명이 사용되는지 여부를 나타내는 개체입니다. 값이 true이면 지정된 서명 라운드를 완료하고 다음 라운드로 진행하려면 서명이 하나만 필요합니다. 예를 들어 { '1': true }은(는) '1' 라운드에 서명할 때 서명이 하나만 필요하다는 것을 의미합니다. |
|
|
usePlaceholders
|
usePlaceholders | boolean |
true이면 문서에 저장된 텍스트 자리 표시자/formFields가 받는 사람을 초대하는 데 사용됩니다. |
|
|
inPersonSigning
|
inPersonSigning | boolean |
true이면 받는 사람이 수동으로 서명을 그려야 하는 팝업을 가져옵니다. |
|
|
folderName
|
folderName | string |
지정된 경우 documentDataArray의 모든 문서를 포함하는 봉투가 만들어집니다. (둘 이상의 문서를 보내는 경우 필수) |
|
|
콜백 URL
|
callbackUrl | string |
문서를 포함한 POST 요청은 새 서명을 만들거나 받는 사람이 문서를 거부할 때 이 URL로 전송됩니다. 오류가 발생할 경우 요청이 다시 시도되도록 재시도 메커니즘이 적용됩니다. |
|
|
returnUrl
|
returnUrl | string |
문서에 서명한 후 반환 단추의 링크 |
|
|
returnBtnText
|
returnBtnText | string |
문서에 서명한 후 반환 단추의 텍스트 |
|
|
data
|
data | True | string |
base64 형식의 문서(PDF 또는 DOCX) 데이터입니다. |
|
mimetype
|
mimetype | string |
문서가 pdf가 아닌 경우 필수 base64로 인코딩된 데이터 PDF 또는 DOCX의 MIME 형식 |
|
|
fileName
|
fileName | True | string |
파일의 이름 |
|
label
|
label | string |
문서를 구성하기 위해 보낼 수 있는 사용자 지정 레이블입니다. |
|
|
페이지
|
page | True | integer |
상자가 있는 페이지 수이며 첫 번째 페이지는 0입니다. |
|
pageWidth
|
pageWidth | integer |
페이지 너비를 설명하는 정수 값입니다. 숫자가 클수록 x y 공간에 상자를 배치할 때 정밀도가 향상됩니다. A4 페이지에는 기본값으로 478이 있습니다. |
|
|
pageHeight
|
pageHeight | integer |
페이지 높이를 설명하는 정수 값입니다. 숫자가 클수록 x y 공간에 상자를 배치할 때 정밀도가 향상됩니다. A4 페이지에는 기본값으로 676이 있습니다. |
|
|
x
|
x | True | float |
상자의 가로 위치를 페이지 너비의 백분율로 나타냅니다. 원본(0,0)이 페이지의 왼쪽 위에 있습니다. 값이 0.1이면 상자가 왼쪽에서 페이지 너비의% 10에 배치됩니다. |
|
y
|
y | True | float |
상자의 세로 위치를 페이지 높이의 백분율로 나타냅니다. 원본(0,0)은 페이지의 왼쪽 위에 있습니다. 값이 0.1이면 상자가 위쪽에서 페이지 높이의% 10에 배치됩니다. |
|
width
|
width | True | float |
x 및 y 좌표와 유사한 페이지 차원을 기준으로 상자의 너비입니다. pageWidth의 백분율을 나타내는 부동 소수 자릿수입니다. |
|
height
|
height | True | float |
x 및 y 좌표와 유사한 페이지 차원을 기준으로 상자의 높이입니다. PageHeight의 백분율을 나타내는 부동 소수 자릿수입니다. |
|
id
|
id | True | string |
원하는 방식으로 생성된 이 상자의 고유 ID입니다. |
|
label
|
label | string |
필드 이름(예: "생년월일")과 같은 자리 표시자 텍스트입니다. |
|
|
value
|
value | string |
상자의 기본값입니다. null일 수 있습니다. 상자가 'chooseBox' 형식인 경우 값은 null이거나 옵션에 정의된 문자열 중 하나일 수 있습니다. |
|
|
읽기 전용
|
readonly | boolean |
true로 설정하면 초대된 사용자가 이 상자의 값을 수정할 수 없습니다. |
|
|
required
|
required | boolean |
true로 설정하면 초대된 사용자가 이 상자를 작성하지 않고 문서에 서명할 수 없습니다. |
|
|
type
|
type | True | string | |
|
여러 줄
|
multiline | boolean |
여러 줄이 허용되는지 여부입니다. |
|
|
displayValue
|
displayValue | True | string | |
|
exportValue
|
exportValue | True | string | |
|
group
|
group | number |
각 라디오 상자를 그룹에 할당할 수 있습니다. |
|
|
signatureTypes
|
signatureTypes | array of string |
이 받는 사람에게 허용되는 서명 유형은 받는 사람 서명 형식으로 덮어쓸 수 있습니다. 옵션: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent'] |
|
|
refId
|
refId | string |
refId는 업로드된 문서를 상호 참조하는 데 사용되는 선택적 필드입니다. 제공된 경우 사용자 지정 참조 식별자를 문서에 할당할 수 있습니다. 이 식별자는 향후 API 응답에서 문서 개체의 일부로 반환됩니다. 외부 시스템 또는 워크플로별로 문서를 추적하거나 구성하는 데 유용할 수 있습니다. |
|
|
language
|
language | string |
문서 언어입니다. |
|
|
folderId
|
folderId | string |
문서를 삽입해야 하는 폴더의 ID입니다. 이는 inviteData 및 folderName이 모두 정의되지 않은 경우에만 가능합니다. |
|
|
isAttachment
|
isAttachment | boolean |
이 경우 isAttachment가 필요하지 않습니다. |
|
|
받는 사람 세부 정보
|
recipientDetails | True | object |
받는 사람 전자 메일로 키가 지정된 받는 사람 세부 정보입니다. 예: {""mail@test.com:{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}]}} |
|
useFastlane
|
useFastlane | boolean |
서명자에게 |
|
|
fastlaneProfileId
|
fastlaneProfileId | uuid |
이 문서에서 사용해야 하는 Fastlane 프로필을 지정합니다. (useFastlane은 true로 설정해야 합니다). |
반품
요청 상태 가져오기
서명 요청의 상태를 가져옵니다. 문서 JSON 개체 또는 오류를 반환합니다. 매개 변수는 문서의 게시 요청에 의해 반환되며 보낸 사람 전자 메일과 연결됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
멤버 ID
|
memberId | True | string |
멤버 ID |
반품
자리 표시자를 사용하여 서명 요청 만들기
업로드된 문서에 저장된 자리 표시자를 사용하여 서명 요청을 만듭니다. 받는 사람 및 서명 위치는 문서에서 추출됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
email
|
True | string |
보낸 사람의 전자 메일입니다. 계획의 멤버에 속해야 합니다. |
|
|
firstName
|
firstName | True | string |
보낸 사람의 이름입니다. |
|
lastName
|
lastName | string |
보낸 사람의 성입니다. |
|
|
role
|
role | string |
모든 문서에서 보낸 사람의 역할입니다. |
|
|
email
|
string |
받는 사람의 전자 메일입니다. |
||
|
firstName
|
firstName | string |
받는 사람의 이름입니다. |
|
|
lastName
|
lastName | string |
받는 사람의 성입니다. |
|
|
doNotSendEmails
|
doNotSendEmails | boolean |
전자 메일이 |
|
|
customId
|
customId | string |
받는 사람의 전자 메일 주소를 초대할 때 알 수 없는 경우에만 사용할 수 있습니다. 이는 받는 사람을 초대하고(경로 준비가 아님) fastlane을 사용하려는 경우에만 작동합니다. 그러면 참고: customId는 문서에 대한 받는 사람 링크를 작성하는 데만 사용할 수 있습니다. memberId 대신 다른 요청에는 사용할 수 없습니다. URL 생성에 대한 자세한 내용은 사용자 지정 ID를 사용하여 문서 열기를 참조하세요. |
|
|
useFastlane
|
useFastlane | boolean |
서명자에게 |
|
|
phoneNumber
|
phoneNumber | string |
이 받는 사람의 전화 번호입니다. SMS 확인에 사용됩니다. (예: +43 699 1234 1234). |
|
|
privateMessage
|
privateMessage | string |
이 특정 받는 사람에 대한 개인 메시지입니다. |
|
|
inPersonMode
|
inPersonMode | boolean |
이 옵션을 사용하도록 설정하면 서명 요청의 받는 사람이 직접 문서에 서명해야 하며 전자 메일이 전송되지 않습니다. 이 모드는 SES 서명 형식을 사용하여만 사용할 수 있습니다. |
|
|
signatureTypes
|
signatureTypes | array of string |
이 받는 사람에게 허용되는 서명 유형입니다. 옵션: ['advanced', 'advancedPlus', 'qualified', 'qualifiedPlusIdent', 'simple'] |
|
|
tag
|
tag | string |
이 태그는 서명 프로세스에 사용할 ID 공급자를 결정합니다. 미리 정의된 지원되는 공급자 집합 중에서 선택합니다.
참고2: 기본 공급자로 사용하는 |
|
|
canChange
|
canChange | boolean |
초대된 받는 사람이 서명 공급자를 변경할 수 있는지 여부를 나타내는 부울 |
|
|
country
|
country | string |
기본 국가이며 비어 있는 경우 모두로 설정하면 선택한 공급자 태그에 사용할 수 있는 국가와 함께 오류가 반환됩니다. |
|
|
기한날짜
|
dueDate | YYYY-MM-DD |
문서에 서명할 수 있는 날짜입니다. 이 기한은 초대 전자 메일의 받는 사람에게 표시되며 대시보드의 문서 세부 정보 섹션에도 표시됩니다. 서명 프로세스를 완료하기 위한 마감일로 사용됩니다. |
|
|
reminderInterval
|
reminderInterval | number |
미리 알림 전자 메일 사이의 일 수를 지정합니다. |
|
|
startSendingReminders
|
startSendingReminders | YYYY-MM-DD HH:MM |
미리 알림을 보내야 하는 날짜 |
|
|
inviteLanguage
|
inviteLanguage | string |
계정이 없는 익명 사용자에게 보낸 전자 메일의 언어를 지정합니다. 계정이 있는 사용자의 경우 프로필에서 선택한 언어가 대신 사용됩니다. |
|
|
message
|
message | string |
전자 메일 내의 받는 사람에게 보낸 사용자 지정 메시지입니다. |
|
|
subject
|
subject | string |
받는 사람에게 보낸 전자 메일의 제목 줄입니다. |
|
|
sendOutFinishedPdf
|
sendOutFinishedPdf | boolean |
true로 설정하면 pdf가 문서의 모든 받는 사람에게 첨부 파일로 전송됩니다(5MB보다 작은 경우). |
|
|
focusedSigningMode
|
focusedSigningMode | boolean |
이 옵션을 사용하도록 설정하면 서명 요청의 받는 사람이 문서 서명 또는 거부로 제한되며 페이지에서 이동할 수 없습니다. |
|
|
allowForwarding
|
allowForwarding | boolean |
초대 전달을 허용합니다. |
|
|
collabSigningMode
|
collabSigningMode | object |
각 키가 서명 라운드를 나타내고 해당 값이 해당 라운드에 대해 공동 서명이 사용되는지 여부를 나타내는 개체입니다. 값이 true이면 지정된 서명 라운드를 완료하고 다음 라운드로 진행하려면 서명이 하나만 필요합니다. 예를 들어 { '1': true }은(는) '1' 라운드에 서명할 때 서명이 하나만 필요하다는 것을 의미합니다. |
|
|
inPersonSigning
|
inPersonSigning | boolean |
true이면 받는 사람이 수동으로 서명을 그려야 하는 팝업을 가져옵니다. |
|
|
folderName
|
folderName | string |
지정된 경우 documentDataArray의 모든 문서를 포함하는 봉투가 만들어집니다. (둘 이상의 문서를 보내는 경우 필수) |
|
|
콜백 URL
|
callbackUrl | string |
문서를 포함한 POST 요청은 새 서명을 만들거나 받는 사람이 문서를 거부할 때 이 URL로 전송됩니다. 오류가 발생할 경우 요청이 다시 시도되도록 재시도 메커니즘이 적용됩니다. |
|
|
returnUrl
|
returnUrl | string |
문서에 서명한 후 반환 단추의 링크 |
|
|
returnBtnText
|
returnBtnText | string |
문서에 서명한 후 반환 단추의 텍스트 |
|
|
data
|
data | True | string |
base64 형식의 문서(PDF 또는 DOCX) 데이터입니다. |
|
mimetype
|
mimetype | string |
문서가 pdf가 아닌 경우 필수 base64로 인코딩된 데이터 PDF 또는 DOCX의 MIME 형식 |
|
|
fileName
|
fileName | True | string |
파일의 이름 |
|
label
|
label | string |
문서를 구성하기 위해 보낼 수 있는 사용자 지정 레이블입니다. |
|
|
페이지
|
page | True | integer |
상자가 있는 페이지 수이며 첫 번째 페이지는 0입니다. |
|
pageWidth
|
pageWidth | integer |
페이지 너비를 설명하는 정수 값입니다. 숫자가 클수록 x y 공간에 상자를 배치할 때 정밀도가 향상됩니다. A4 페이지에는 기본값으로 478이 있습니다. |
|
|
pageHeight
|
pageHeight | integer |
페이지 높이를 설명하는 정수 값입니다. 숫자가 클수록 x y 공간에 상자를 배치할 때 정밀도가 향상됩니다. A4 페이지에는 기본값으로 676이 있습니다. |
|
|
x
|
x | True | float |
상자의 가로 위치를 페이지 너비의 백분율로 나타냅니다. 원본(0,0)은 페이지의 왼쪽 위에 있습니다. 값이 0.1이면 상자가 왼쪽에서 페이지 너비의% 10에 배치됩니다. |
|
y
|
y | True | float |
상자의 세로 위치를 페이지 높이의 백분율로 나타냅니다. 원본(0,0)이 페이지의 왼쪽 위에 있습니다. 값이 0.1이면 상자가 위쪽에서 페이지 높이의% 10에 배치됩니다. |
|
width
|
width | True | float |
x 및 y 좌표와 유사한 페이지 차원을 기준으로 상자의 너비입니다. pageWidth의 백분율을 나타내는 부동 소수 자릿수입니다. |
|
height
|
height | True | float |
x 및 y 좌표와 유사한 페이지 차원을 기준으로 상자의 높이입니다. PageHeight의 백분율을 나타내는 부동 소수 자릿수입니다. |
|
id
|
id | True | string |
원하는 방식으로 생성된 이 상자의 고유 ID입니다. |
|
label
|
label | string |
필드 이름(예: "생년월일")과 같은 자리 표시자 텍스트입니다. |
|
|
value
|
value | string |
상자의 기본값입니다. null일 수 있습니다. 상자가 'chooseBox' 형식인 경우 값은 null이거나 옵션에 정의된 문자열 중 하나일 수 있습니다. |
|
|
읽기 전용
|
readonly | boolean |
true로 설정하면 초대된 사용자가 이 상자의 값을 수정할 수 없습니다. |
|
|
required
|
required | boolean |
true로 설정하면 초대된 사용자가 이 상자를 작성하지 않고 문서에 서명할 수 없습니다. |
|
|
type
|
type | True | string | |
|
여러 줄
|
multiline | boolean |
여러 줄이 허용되는지 여부입니다. |
|
|
displayValue
|
displayValue | True | string | |
|
exportValue
|
exportValue | True | string | |
|
group
|
group | number |
각 라디오 상자를 그룹에 할당할 수 있습니다. |
|
|
signatureTypes
|
signatureTypes | array of string |
이 받는 사람에게 허용되는 서명 유형은 받는 사람 서명 형식으로 덮어쓸 수 있습니다. 옵션: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent'] |
|
|
refId
|
refId | string |
refId는 업로드된 문서를 상호 참조하는 데 사용되는 선택적 필드입니다. 제공된 경우 사용자 지정 참조 식별자를 문서에 할당할 수 있습니다. 이 식별자는 향후 API 응답에서 문서 개체의 일부로 반환됩니다. 외부 시스템 또는 워크플로별로 문서를 추적하거나 구성하는 데 유용할 수 있습니다. |
|
|
language
|
language | string |
문서 언어입니다. |
|
|
folderId
|
folderId | string |
문서를 삽입해야 하는 폴더의 ID입니다. 이는 inviteData 및 folderName이 모두 정의되지 않은 경우에만 가능합니다. |
|
|
isAttachment
|
isAttachment | boolean |
이 경우 isAttachment가 필요하지 않습니다. |
|
|
useFastlane
|
useFastlane | boolean |
서명자에게 |
|
|
fastlaneProfileId
|
fastlaneProfileId | uuid |
이 문서에서 사용해야 하는 Fastlane 프로필을 지정합니다. (useFastlane은 true로 설정해야 합니다). |
반품
정의
DeleteDocumentResponse
- 문서 응답 삭제
- string
EnvelopeResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
folderId
|
folderId | string | |
|
folderName
|
folderName | string | |
|
문서
|
documents | array of object | |
|
id
|
documents.id | string | |
|
name
|
documents.name | string | |
|
language
|
documents.language | string | |
|
startSendingReminders
|
documents.startSendingReminders | date-time |
미리 알림이 전송되기 시작하는 날짜 및 시간(ISO 8601 datetime 문자열) |
|
sendReminder
|
documents.sendReminder | boolean | |
|
reminderSent
|
documents.reminderSent | boolean | |
|
reminderInterval
|
documents.reminderInterval | number | |
|
createdAt
|
documents.createdAt | date-time |
문서를 만든 날짜 및 시간(ISO 8601 datetime 문자열) |
|
콜백 URL
|
documents.callbackUrl | string | |
|
returnUrl
|
documents.returnUrl | string | |
|
returnBtnText
|
documents.returnBtnText | string | |
|
inPersonSigning
|
documents.inPersonSigning | boolean | |
|
signingRound
|
documents.signingRound | number | |
|
isTemplate
|
documents.isTemplate | boolean | |
|
templateId
|
documents.templateId | string | |
|
linkId
|
documents.linkId | string | |
|
linkExpiresAt
|
documents.linkExpiresAt | string | |
|
derivedFromLink
|
documents.derivedFromLink | boolean | |
|
state
|
documents.state | string | |
|
complianceLevel
|
documents.complianceLevel | string | |
|
allowForwarding
|
documents.allowForwarding | boolean | |
|
linkExpires
|
documents.linkExpires | boolean | |
|
setDueDate
|
documents.setDueDate | boolean | |
|
기한날짜
|
documents.dueDate | date-time |
문서의 기한(ISO 8601 datetime 문자열) |
|
focusedSigningMode
|
documents.focusedSigningMode | boolean | |
|
linkMaxSignaturesEnabled
|
documents.linkMaxSignaturesEnabled | boolean | |
|
linkMaxSignatures
|
documents.linkMaxSignatures | number | |
|
fastlaneProfileId
|
documents.fastlaneProfileId | string | |
|
refId
|
documents.refId | string | |
|
sendOutFinishedPdf
|
documents.sendOutFinishedPdf | boolean | |
|
signatureTypes
|
documents.signatureTypes | array of string | |
|
members
|
documents.members | array of MemberResponseSchema | |
|
회원
|
documents.member | MemberResponseSchema | |
|
박스
|
documents.boxes | array of DocumentResponseBox |
문서 응답의 양식 필드 상자입니다. 이 값은 문서에 양식 필드가 있는 경우에만 반환됩니다. 문서에 서명하면 문서에 입력된 값이 포함된 상자가 반환됩니다. |
|
기한이 지난
|
documents.overdue | boolean |
DocumentResponseBox
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
id
|
id | string | |
|
type
|
type | string | |
|
value
|
value | string |
상자 필드의 값입니다. 상자 형식에 따라 문자열(빈 문자열 포함), 부울 또는 null일 수 있습니다. |
|
label
|
label | string |
MemberResponseSchema
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
id
|
id | string | |
|
documentId
|
documentId | string | |
|
email
|
string | ||
|
firstName
|
firstName | string | |
|
lastName
|
lastName | string | |
|
isAdmin
|
isAdmin | boolean | |
|
createdAt
|
createdAt | date-time |
멤버가 만들어진 날짜 및 시간(ISO 8601 datetime 문자열) |
|
sentDeleteNotificationAt
|
sentDeleteNotificationAt | date-time |
삭제 알림이 전송된 날짜 및 시간(ISO 8601 datetime 문자열) |
|
manuallyLastEmailSent
|
manuallyLastEmailSent | date-time |
마지막 수동 전자 메일이 전송된 날짜 및 시간(ISO 8601 datetime 문자열) |
|
signaturePosition
|
signaturePosition | MemberSignaturePositionResponse |
추가 응답 관련 필드가 있는 서명 위치 데이터입니다. cardStyle, pageWidth 및 pageHeight 필드는 선택 사항이며 모든 API 응답에 없을 수 있습니다. |
|
doNotSendEmails
|
doNotSendEmails | boolean | |
|
declinedAt
|
declinedAt | date-time |
멤버가 거부된 날짜 및 시간(ISO 8601 datetime 문자열) |
|
signingOrder
|
signingOrder | number | |
|
온디맨드
|
onDemand | string | |
|
recipientId
|
recipientId | string | |
|
signatureTypes
|
signatureTypes | array of string | |
|
signatureTypesActive
|
signatureTypesActive | boolean | |
|
privateMessage
|
privateMessage | string | |
|
customId
|
customId | string | |
|
useFastlane
|
useFastlane | boolean | |
|
role
|
role | string | |
|
approvedAt
|
approvedAt | date-time |
멤버가 승인된 날짜 및 시간(ISO 8601 datetime 문자열) |
|
확인 구성
|
verificationConfig | ||
|
phoneNumber
|
phoneNumber | string | |
|
서명
|
signatures | array of string | |
|
signedAt
|
signedAt | date-time |
멤버가 서명된 날짜 및 시간(ISO 8601 datetime 문자열) |
MemberSignaturePositionResponse
추가 응답 관련 필드가 있는 서명 위치 데이터입니다. cardStyle, pageWidth 및 pageHeight 필드는 선택 사항이며 모든 API 응답에 없을 수 있습니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
SignaturePositionResponse |
추가 응답 관련 필드가 있는 서명 위치 데이터입니다. cardStyle, pageWidth 및 pageHeight 필드는 선택 사항이며 모든 API 응답에 없을 수 있습니다. |
SignaturePositionResponse
추가 응답 관련 필드가 있는 서명 위치 데이터입니다. cardStyle, pageWidth 및 pageHeight 필드는 선택 사항이며 모든 API 응답에 없을 수 있습니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
페이지
|
page | integer |
페이지 번호(0부터 시작)입니다. |
|
x
|
x | number |
서명의 왼쪽 위 위치 x 좌표 |
|
y
|
y | number |
서명의 왼쪽 위 위치 y 좌표 |
|
width
|
width | number |
서명의 너비입니다. |
|
height
|
height | number |
서명의 높이입니다. |
|
cardStyle
|
cardStyle | string |
서명 카드의 비주얼 스타일입니다. 이 필드는 선택 사항이며 모든 응답에서 반환되지 않을 수 있습니다. |
|
pageWidth
|
pageWidth | number |
페이지의 너비(픽셀)입니다. 이 필드는 선택 사항이며 모든 응답에서 반환되지 않을 수 있습니다. |
|
pageHeight
|
pageHeight | number |
페이지의 높이(픽셀)입니다. 이 필드는 선택 사항이며 모든 응답에서 반환되지 않을 수 있습니다. |
DocumentStatusForFlow
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
id
|
id | string | |
|
name
|
name | string | |
|
state
|
state | string |
문서의 현재 상태입니다. 가능한 값은 초안, 보류 중, 거부됨, 완료됨, 첨부 파일, 수동으로 지출, 수동으로 컴파일됨 |
|
createdAt
|
createdAt | date | |
|
updatedAt
|
updatedAt | date | |
|
allSignersSigned
|
allSignersSigned | boolean | |
|
allMembersSigned
|
allMembersSigned | boolean | |
|
focusedSigningMode
|
focusedSigningMode | boolean |