Legalesign(미리 보기)
규정 준수 중심 법률 및 운영 팀을 위해 설계된 Legalesign의 커넥터는 Microsoft Power Platform을 Legalesign eSignature와 연결하여 문서 및 받는 사람 워크플로를 트리거하고, 미리 알림을 보내고, PDF를 가져오고, 양식 데이터를 노출합니다. API 사용을 위해 승인된 활성 Legalesign 구독이 필요합니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | 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) |
| Power Automate (파워 오토메이트) | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 연락처 | |
|---|---|
| 이름 | API 지원 |
| URL | https://legalesign.com/contact/ |
| 전자 메일 | sales@legalesign.com |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Legalesign |
| Legalesign에 대해 자세히 알아보기 | https://docs.microsoft.com/connectors/legalesign |
| 웹 사이트 | https://legalesign.com |
| 개인 정보 보호 정책 | https://legalesign.com/opn/privacy/ |
| 카테고리 | 콘텐츠 및 파일; 생산력 |
Legalesign eSignature REST 커넥터
Legalesign REST API는 eSignature 워크플로를 지원합니다. 이 커넥터는 전체 API 액세스 및 실시간 트리거를 제공하여 Microsoft Power Automate, Logic Apps 및 관련 플랫폼과 원활하게 통합할 수 있도록 합니다.
필수 조건
시작하려면 Legalesign 계정 및 API 키가 필요합니다. 1. 평가판에 등록하세요. 2. 그룹을 만듭니다(예: 개발용 환경과 프로덕션용 환경). 3. 지원 티켓을 만들어 API 키를 요청합니다. 지원에서 ID를 확인할 수 있도록 사용 사례, 회사 및 역할을 포함합니다. 4. 확인되면 API 대시보드 에 로그인하여 키를 검색합니다.
배치
새 계정은 다음과 같은 제한 사항으로 샌드박스 모드에서 시작됩니다. • 문서는 API 대시보드에서 구성한 이메일 주소를 테스트하기 위해만 보낼 수 있습니다. • 요청이 100분으로 제한됩니다.
라이브로 전환할 준비가 되면 샌드박스에서 프로덕션으로 계정을 전환하는 지원 티켓을 만듭니 다. 이 시점에서 제한 사항이 해제됩니다. 자세한 내용은 배포 가이드 를 참조하세요.
유발 요소
커넥터는 두 가지 실시간 트리거를 지원합니다.
- 문서 이벤트(예: 생성됨, 거부됨, 서명됨, 최종 PDF 생성)
- 받는 사람 이벤트(예: 완료됨, 거부됨, 전자 메일 열기, 반송됨, 보낸 미리 알림)
그룹 또는 이벤트 유형별로 필터의 모든 문서 또는 받는 사람을 받을 수 있습니다. 연결된 모든 Legalesign 웹후크는 API 대시보드에서 관리 및 모니터링할 수 있습니다.
Operations
Legalesign REST API 작업이 지원됩니다. 가장 일반적인 예로는 서명된 PDF 다운로드, 서식 파일, 문서, 받는 사람 및 필드 배치 관리가 포함됩니다. 전체 사양은 전체 API 설명서를 참조하세요.
Legalesign에서 업로드된 문서를 '템플릿'이라고 합니다. 하나 이상의 받는 사람에게 템플릿을 보내면 '문서'가 됩니다. 일반적으로 템플릿을 업로드하고, 식별자를 복구한 다음, 하나 이상의 받는 사람에게 보냅니다.
일반적인 작업은 다음과 같습니다.
템플릿
-
Create PDF template- 서식 파일(PDF, Word 또는 이미지와 같은 모든 파일 형식)을 업로드합니다. -
Get PDF embeddable link- 사용자에게 템플릿 편집기를 표시하는 일회용 링크
문서
-
Location to download PDF- 서명된 문서의 PDF 이진 파일을 반환합니다. -
Create signing document- 문서 보내기(서식 파일 및 받는 사람 선택) -
Void/archive signing document- 문서의 서명 중지 -
Permanently delete signing document- 문서를 영원히 제거합니다.
받는 사람(서명자)
-
Send signer reminder email- 받는 사람에게 문서를 완료하도록 미리 알림 -
Get signer rejection reason- 문서가 거부된 경우 이유를 참조하세요.
필드 배치
Legalesign에는 필드가 있는 고급 양식 시스템이 있습니다. 서명자가 있는 경우 각 서명자에는 하나 이상의 서명 필드가 있어야 합니다.
템플릿에서 필드를 정의하는 네 가지 방법이 있습니다.
- 포함된 필드가 있는 PDF를 업로드합니다(Legalesign에서 자동 변환).
- Legalesign 텍스트 태그를 사용합니다.
- x/y 좌표를 정의합니다.
- Embed 링크 또는 웹앱을 통해 Legalesign 양식 편집기를 사용합니다.
쿼리 및 지원
추가 지원 또는 쿼리를 보려면 Legalesign 계정에 로그인하고 지원 티켓을 만듭니다.
연결 만들기
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| API 키 | 시큐어스트링 (보안 문자열) | 이 api에 대한 api_key | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| PDF 다운로드 |
상태에 따라 서명 문서에 대한 초안 또는 최종 PDF를 가져옵니다. 200 또는 302 응답이 가능합니다. |
| PDF 서식 파일 가져오기 |
특정 PDF 서식 파일의 세부 정보 |
| PDF 서식 파일 가져오기 |
PDF 서식 파일 나열 |
| PDF 서식 파일 업로드 |
서명할 PDF 문서를 업로드합니다. |
| PDF 첨부 파일 업로드 |
받는 사람 전자 메일에 첨부하려면 pdf를 저장합니다. |
| PDF 포함 가능 링크 가져오기 |
PDF 편집기를 포함할 일회용 링크를 반환합니다. |
| Void 및 보관 문서 |
상태 40이 제거된 문서를 설정하고 보관합니다. |
| 그룹 가져오기 |
API 사용자가 속한 그룹 나열 |
| 그룹의 구성원 |
그룹 내의 특정 사용자에 대한 세부 정보입니다. |
| 그룹의 구성원 |
그룹의 모든 멤버 목록입니다. |
| 문서 가져오기 |
특정 문서를 반환합니다. |
| 문서 가져오기 |
보관되지 않은 서명 문서를 나열합니다. |
| 문서 감사 로그 다운로드 |
문서 감사 로그의 PDF입니다. |
| 문서 보내기 |
서명 또는 승인을 위해 문서를 보냅니다. |
| 문서 영구 삭제 |
데이터 및 파일을 영구적으로 삭제합니다. |
| 문서 필드 가져오기 |
문서의 필드입니다. |
| 받는 사람 가져오기 |
개별 받는 사람의 상태 및 세부 정보를 가져옵니다. |
| 받는 사람 거부 이유 가져오기 |
서명자가 문서를 거부하도록 지정한 이유를 반환합니다. |
| 받는 사람 링크 가져오기 |
받는 사람이 서명 페이지로 이동하는 일회용 링크입니다. |
| 받는 사람 미리 알림 전자 메일 보내기 |
받는 사람에게 미리 알림 전자 메일을 보냅니다. |
| 받는 사람 양식 필드 가져오기 |
특정 받는 사람으로부터 양식 필드를 반환합니다. |
| 사용자 가져오기 |
사용자 세부 정보를 가져옵니다. |
| 첨부 파일 가져오기 |
첨부 파일을 가져옵니다. |
| 첨부 파일 가져오기 |
첨부 파일을 나열합니다. |
| 첨부 파일 삭제 |
첨부 파일을 삭제합니다. |
PDF 다운로드
상태에 따라 서명 문서에 대한 초안 또는 최종 PDF를 가져옵니다. 200 또는 302 응답이 가능합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
문서 ID
|
docId | True | uuid |
문서 ID |
반환
- response
- file
PDF 서식 파일 가져오기
특정 PDF 서식 파일의 세부 정보
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
업로드된 PDF ID
|
pdfId | True | uuid |
업로드된 PDF ID |
반환
템플릿 세부 정보
PDF 서식 파일 가져오기
PDF 서식 파일 나열
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
그룹 ID
|
group | string |
전체 resource_uri 또는 ID만 사용할 수 있습니다. |
|
|
쿼리 제한
|
limit | integer |
반환할 데이터 세트의 길이입니다. 오프셋 쿼리와 함께 사용하여 결과를 반복합니다. |
|
|
쿼리 오프셋
|
offset | integer |
데이터 세트의 시작부터 오프셋입니다. 제한 쿼리와 함께 사용하여 데이터 세트를 반복합니다. |
반환
템플릿 목록
PDF 서식 파일 업로드
서명할 PDF 문서를 업로드합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
전송 시 보관
|
archive_upon_send | boolean |
이 업로드가 일회용인 경우 true를 설정합니다. |
|
|
그룹
|
group | True | string |
사용할 그룹을 지정합니다. |
|
PDF 파일
|
pdf_file | True | byte |
Base64로 인코딩된 PDF 파일 데이터입니다. |
|
프로세스 태그
|
process_tags | boolean |
파일에 텍스트 태그가 포함되어 있으면 필드로 변환합니다. |
|
|
제목
|
title | string |
이 레코드의 이름을 지정합니다. 사용하지 않는 경우 파일 이름을 사용합니다. |
|
|
사용자
|
user | string |
api 사용자가 아닌 경우 그룹 멤버에 할당합니다. |
PDF 첨부 파일 업로드
받는 사람 전자 메일에 첨부하려면 pdf를 저장합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
group
|
group | True | string |
그룹 리소스 URI |
|
pdf_file
|
pdf_file | True | byte |
Base64로 인코딩된 PDF 파일 데이터, 최대 크기는 기본적으로 5MB의 그룹 설정입니다. |
|
filename
|
filename | True | string |
.pdf 끝나는 단순 영숫자 이름 |
|
사용자
|
user | string |
다른 사용자에게 할당합니다. |
|
|
description
|
description | string |
PDF 포함 가능 링크 가져오기
PDF 편집기를 포함할 일회용 링크를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Pdf Id
|
pdfId | True | string |
업로드된 PDF ID를 설정합니다. |
|
렌더링된 페이지에서 필드 목록 숨기기
|
hide_sender_fields | boolean |
렌더링된 페이지에서 필드 목록을 숨깁니다. |
|
|
배경색에 해시 기호를 제외한 16진수 코드
|
css_body_backgroundcolor | string |
해시 기호를 제외한 16진수 코드를 사용하여 배경색을 변경합니다. |
Void 및 보관 문서
상태 40이 제거된 문서를 설정하고 보관합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
문서 ID
|
docId | True | uuid |
문서 ID |
|
받는 사람에게 알림 전자 메일 보내기
|
string |
true 또는 1로 설정하면 받는 사람에게 문서가 무효화된다는 알림이 표시됩니다. |
그룹 가져오기
API 사용자가 속한 그룹 나열
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
쿼리 오프셋
|
offset | integer |
데이터 세트의 시작부터 오프셋입니다. 제한 쿼리와 함께 사용하여 데이터 세트를 반복합니다. |
|
|
쿼리 제한
|
limit | integer |
반환할 데이터 세트의 길이입니다. 오프셋 쿼리와 함께 사용하여 결과를 반복합니다. |
반환
그룹 목록
그룹의 구성원
그룹 내의 특정 사용자에 대한 세부 정보입니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
멤버 ID
|
memberId | True | uuid |
멤버 ID |
반환
그룹의 구성원
그룹의 모든 멤버 목록입니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
그룹 ID
|
group | string |
특정 그룹별로 필터링 |
|
|
쿼리 제한
|
limit | integer |
결과를 반복하려면 오프셋과 함께 사용합니다. |
|
|
쿼리 오프셋
|
offset | integer |
결과를 반복하려면 제한과 함께 사용합니다. |
반환
문서 가져오기
특정 문서를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
문서 ID
|
docId | True | uuid |
문서 ID |
반환
문서 세부 정보
문서 가져오기
보관되지 않은 서명 문서를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
그룹 ID
|
group | True | string |
필요한 특정 그룹별로 필터링합니다. |
|
보관된 문서 포함
|
archived | string |
보관된 상태를 필터링합니다. 기본값은 보관되지 않습니다. 이 매개 변수의 모든 값을 사용하여 모든 문서를 쿼리합니다. |
|
|
받는 사람 전자 메일로 필터링
|
string |
받는 사람 전자 메일로 필터링합니다. |
||
|
쿼리 제한
|
limit | integer |
반환할 데이터 세트의 길이입니다. 오프셋 쿼리와 함께 사용하여 결과를 반복합니다. |
|
|
쿼리 오프셋
|
offset | integer |
데이터 세트의 시작부터 오프셋입니다. 제한 쿼리와 함께 사용하여 데이터 세트를 반복합니다. |
|
|
문서 상태별로 필터링
|
status | integer |
문서 상태를 필터링합니다. |
|
|
응답에서 받는 사람 제거
|
nosigners | string |
값 1을 추가하여 더 빠른 쿼리를 위해 받는 사람 정보를 제거합니다. |
|
|
이 날짜 이후에 만든 필터
|
created_gt | date-time |
특정 시간 후에 만든 문서를 필터링합니다. |
|
|
이 날짜 이후에 수정된 필터
|
modified_gt | date-time |
특정 시간 후에 수정된 문서에 대해 필터링합니다. |
반환
문서 목록
문서 감사 로그 다운로드
문서 보내기
서명 또는 승인을 위해 문서를 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
그룹
|
group | True | string |
그룹 리소스 URI |
|
이름
|
name | True | string |
문서의 이름 지정 |
|
PDF 서식 파일
|
templatepdf | True | string |
보낼 업로드된 PDF입니다. |
|
메일 주소
|
True |
전자 메일 |
||
|
이름
|
firstname | True | string |
이름 (이름의 첫 부분) |
|
성씨
|
lastname | True | string |
성(姓) |
|
attachments
|
attachments | array of string |
첨부 파일 리소스 URI 목록입니다. |
|
|
만료
|
expires | date-time |
ISO8601 형식의 datetime, 보낸 사람의 TZ 또는 표준 시간대로 설정(사용하는 경우) |
|
|
message
|
message | string |
그룹 전자 메일 서식 파일의 중앙에 입력된 파티에 대한 개인 메시지입니다. 해시 기호로 앞에 지정된 저장된 전자 메일 템플릿의 이름을 사용하여 해당 템플릿을 사용합니다. 동일한 이름의 템플릿이 두 개 이상 있는 경우 마지막으로 수정한 템플릿을 선택합니다. |
|
|
이름
|
firstname | string |
이름 (이름의 첫 부분) |
|
|
성씨
|
lastname | string |
성(姓) |
|
|
메일 주소
|
True |
전자 메일 |
||
|
include_link
|
include_link | boolean |
검토자가 서명할 수 있도록 서명 페이지에 대한 링크 포함 |
|
|
sms
|
sms | string |
국제 서식 번호를 사용하여 SMS 확인을 추가합니다. 감시자 또는 감시된 서명자의 경우 필수입니다. |
|
|
제목
|
subject | string |
아웃바운드 전자 메일의 제목 줄 |
|
|
시간대
|
timezone | string |
서명자의 TZ는 표준 시간대에 따라 유효한 TZ여야 합니다(표준 시간대 세부 정보는 사용자 참조). 빈 경우 보낸 사람의 tz를 사용합니다. |
|
|
서명 유형
|
signature_type | integer |
4를 사용하여 실행된 PDF 인증을 가져옵니다. 권장됩니다. 기본값은 1입니다(문서 무결성에 sha256 해시 사용). |
|
|
PDF 추가
|
append_pdf | boolean |
최종 PDF에 Legalesign 유효성 검사 정보를 추가합니다. |
|
|
auto_archive
|
auto_archive | boolean |
서명 후 곧 보관으로 보냅니다. 웹앱의 낮은 우선 순위 유지 |
|
|
Legalesign 전자 메일 사용
|
do_email | boolean |
Legalesign 전자 메일을 사용하여 알림 이메일을 보냅니다. false이면 모든 전자 메일이 표시되지 않습니다. |
|
|
완료 시 CC
|
cc_emails | string |
서명 또는 거부 알림을 받은 전자 메일 주소의 쉼표로 구분된 문자열입니다. |
|
|
빈 보낸 사람 필드를 첫 번째 받는 사람 필드로 변환
|
convert_sender_to_signer | boolean |
보낸 사람 필드가 비어 있는 경우 첫 번째 받는 사람의 필드로 변환합니다. |
|
|
PDF 암호
|
pdf_password | string |
암호를 설정합니다. ascii 인코딩 가능해야 하며, signature_type 4로 설정하고 pdf_password_type 선택해야 합니다. |
|
|
PDF 암호 설정
|
pdf_password_type | integer |
암호를 저장하려면 1, 최종 서명 시 레코드에서 삭제하려면 2입니다. |
|
|
pdftext
|
pdftext | object |
PDF 보낸 사람 필드에 값을 할당하고 템플릿의 필드 레이블 또는 uuid를 개체 키로 사용합니다. 레이블 또는 uuid를 사용하여 관련 필드를 가져오려면 templatepdf/:id/fields/를 참조하고 element_type="admin"에 대한 필터를 참조하세요. strict_fields 참조하세요. |
|
|
리디렉션 URL
|
redirect | string |
서명 후(다운로드 페이지 대신) 서명자를 보낼 URL입니다. URL에는 다음과 같이 ID 및 상태 정보가 포함된 쿼리 매개 변수가 포함됩니다. YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id]&signer_state=[signer_status]&doc_state=[doc_status] |
|
|
미리 알림 일정
|
reminders | string |
그룹에서 기본 미리 알림 일정을 사용하려는 경우 'default'를 입력합니다(기본 일정을 설정하려면 웹앱으로 이동). |
|
|
서명자 링크 반환
|
return_signer_links | boolean |
응답 BODY의 서명자에 대한 문서 링크를 반환합니다. |
|
|
시퀀싱 보내기
|
signers_in_order | boolean |
서명자에게 주문 순서대로 알립니다. false이면 모두 시뮬레이션적으로 알림을 받습니다. |
|
|
signertext
|
signertext | object |
서명자 필드에 사용자 지정 자리 표시자를 추가합니다. 개체에서 필드 레이블 또는 uuid를 키로 사용합니다(pdftext의 경우). templatepdf/:id/fields/를 참조하고 레이블 또는 uuid를 사용하여 관련 필드를 가져오려면 element_type = "text"에 대한 필터를 참조하세요. |
|
|
필드 유효성 검사 적용
|
strict_fields | boolean |
Pdftext는 유효성 검사에 자동으로 실패하고 유효성을 검사하려면 true를 설정합니다. |
|
|
참조
|
tag | string |
Tag |
|
|
참조
|
tag1 | string |
Tag |
|
|
참조
|
tag2 | string |
Tag |
|
|
사용자
|
user | string |
그룹의 다른 사용자에게 문서를 할당합니다. |
문서 영구 삭제
데이터 및 파일을 영구적으로 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
문서 ID
|
docId | True | uuid |
문서 ID |
문서 필드 가져오기
문서의 필드입니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
문서 ID
|
docId | True | uuid |
문서 ID |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
|
array of object |
문서 필드 목록 |
|
|
element_type
|
element_type | string |
요소 타입 |
|
fieldorder
|
fieldorder | integer |
필드 순서 |
|
label
|
label | string |
라벨 |
|
label_extra
|
label_extra | string |
추가 레이블 |
|
서명자
|
signer | integer |
Recipient |
|
주
|
state | boolean | |
|
유효성 검사
|
validation | integer |
유효성 검사 식별자 |
|
value
|
value | string |
가치 |
받는 사람 가져오기
개별 받는 사람의 상태 및 세부 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
받는 사람 ID
|
recipientId | True | uuid |
받는 사람 ID |
반환
받는 사람 세부 정보
받는 사람 거부 이유 가져오기
서명자가 문서를 거부하도록 지정한 이유를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
받는 사람 ID
|
recipientId | True | uuid |
받는 사람 ID |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
status
|
status | integer |
받는 사람 동상. |
|
이유
|
reason | string |
이유를 거부합니다. |
받는 사람 링크 가져오기
받는 사람이 서명 페이지로 이동하는 일회용 링크입니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
받는 사람 ID
|
recipientId | True | uuid |
받는 사람 ID |
받는 사람 미리 알림 전자 메일 보내기
받는 사람에게 미리 알림 전자 메일을 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
받는 사람 ID
|
recipientId | True | uuid |
받는 사람 ID |
|
문자 메시지
|
text | string |
사용자 지정 메시지 텍스트 |
받는 사람 양식 필드 가져오기
특정 받는 사람으로부터 양식 필드를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
받는 사람 ID
|
recipientId | True | uuid |
받는 사람 ID |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
|
array of object | ||
|
label
|
label | string |
라벨 |
|
label_extra
|
label_extra | string |
추가 레이블 |
|
주
|
state | boolean |
주 |
|
fieldorder
|
fieldorder | integer |
필드 순서 |
|
value
|
value | string |
필드가 서명자 파일인 경우 이 값은 수명이 짧은 다운로드 URL이 됩니다. |
사용자 가져오기
사용자 세부 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
사용자 ID
|
userId | True | uuid |
사용자 ID |
반환
사용자의 세부 정보입니다.
첨부 파일 가져오기
첨부 파일을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
첨부 파일 ID
|
attachId | True | uuid |
첨부 파일 ID |
반환
항목을 첨부합니다.
첨부 파일 가져오기
첨부 파일을 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
그룹 ID
|
group | string |
특정 그룹별로 필터링합니다. |
|
|
쿼리 제한
|
limit | integer |
결과를 반복하려면 오프셋과 함께 사용합니다. |
|
|
쿼리 오프셋
|
offset | integer |
결과를 반복하려면 제한과 함께 사용합니다. |
반환
첨부 파일 목록
첨부 파일 삭제
첨부 파일을 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
첨부 파일 ID
|
attachId | True | uuid |
ID 연결 |
트리거
| 문서 이벤트 |
문서 이벤트에 대한 트리거 발생 |
| 받는 사람 이벤트 |
받는 사람 이벤트가 발생하는 경우에 대한 트리거 |
문서 이벤트
문서 이벤트에 대한 트리거 발생
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
eventFilter
|
eventFilter | True | string |
이벤트 필터 |
|
group
|
group | string |
그룹 필터 |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
version
|
version | string |
버전 |
|
객체
|
object | string |
Object |
|
tag1
|
data.tag1 | string |
Tag |
|
recipients
|
data.recipients | array of object |
받는 사람 |
|
UUID (범용 고유 식별자)
|
data.recipients.uuid | string |
받는 사람 ID |
|
메일 주소
|
data.recipients.email | string |
받는 사람 전자 메일 |
|
order
|
data.recipients.order | integer |
받는 사람 주문 번호 |
|
status
|
data.recipients.status | integer |
받는 사람 상태 |
|
성씨
|
data.recipients.lastname | string |
받는 사람 성 |
|
roleText
|
data.recipients.roleText | string |
받는 사람 역할 텍스트 |
|
이름
|
data.recipients.firstname | string |
받는 사람 이름 |
|
상태텍스트
|
data.recipients.statusText | string |
받는 사람 statusText |
|
resourceUri
|
data.recipients.resourceUri | string |
받는 사람 리소스 URI |
|
rejectReason
|
data.recipients.rejectReason | string |
rejectReason |
|
groupResourceUri
|
data.groupResourceUri | string |
그룹 리소스 URI |
|
상태텍스트
|
data.statusText | string |
문서 상태 텍스트 |
|
이름
|
data.name | string |
문서 이름 |
|
tag
|
data.tag | string |
Tag |
|
resourceUri
|
data.resourceUri | string |
리소스 URI |
|
UUID (범용 고유 식별자)
|
data.uuid | string |
문서 ID |
|
tag2
|
data.tag2 | string |
Tag2 |
|
group
|
data.group | string |
그룹 |
|
status
|
data.status | integer |
문서 상태 |
|
created
|
created | integer |
생성됨 |
|
아이디
|
id | string |
했나요? |
|
이벤트
|
event | string |
Event |
받는 사람 이벤트
받는 사람 이벤트가 발생하는 경우에 대한 트리거
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
eventFilter
|
eventFilter | True | string |
이벤트 필터 |
|
group
|
group | string |
그룹 필터 |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
version
|
version | string |
버전 |
|
객체
|
object | string |
Object |
|
tag
|
data.tag | string |
Tag |
|
tag1
|
data.tag1 | string |
Tag1 |
|
tag2
|
data.tag2 | string |
Tag2 |
|
UUID (범용 고유 식별자)
|
data.uuid | string |
받는 사람 ID |
|
메일 주소
|
data.email | string |
전자 메일 |
|
group
|
data.group | string |
그룹 |
|
order
|
data.order | integer |
순서 |
|
status
|
data.status | integer |
상태 |
|
문서
|
data.document | string |
문서 |
|
성씨
|
data.lastname | string |
성(姓) |
|
roleText
|
data.roleText | string |
역할 텍스트 |
|
이름
|
data.firstname | string |
이름 (이름의 첫 부분) |
|
상태텍스트
|
data.statusText | string |
상태 텍스트 |
|
emailBounce
|
data.emailBounce | integer |
이메일이 반송되었습니다. |
|
resourceUri
|
data.resourceUri | string |
받는 사람 리소스 URI |
|
문서 이름
|
data.documentName | string |
문서 이름 |
|
rejectReason
|
data.rejectReason | string |
거부 이유 |
|
groupResourceUri
|
data.groupResourceUri | string |
그룹 리소스 URI |
|
emailBounceMessage
|
data.emailBounceMessage | string |
전자 메일 반송 메시지 |
|
documentResourceUri
|
data.documentResourceUri | string |
문서 리소스 URI |
|
created
|
created | integer |
생성됨 |
|
아이디
|
id | string |
아이디 |
|
이벤트
|
event | string |
Event |
정의
PermissionsEnum
ListMeta
목록에 대한 메타 정보입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
limit
|
limit | integer |
최대 개체 수입니다. |
|
next
|
next | string |
다음 개체 집합에 대한 URL입니다. |
|
offset
|
offset | integer |
결과 집합의 시작부터의 항목 수입니다. |
|
이전의
|
previous | string |
이전 개체 집합의 URL입니다. |
|
total_count
|
total_count | integer |
총 개체 수입니다. |
GroupListResponse
그룹 목록
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
메타
|
meta | ListMeta |
목록에 대한 메타 정보입니다. |
|
개체
|
objects | array of object | |
|
created
|
objects.created | date-time |
생성됨 |
|
is_active
|
objects.is_active | boolean |
Active |
|
으로 바뀌었습니다
|
objects.modified | date-time |
수정됨 |
|
이름
|
objects.name | string |
이름 |
|
public_name
|
objects.public_name | string |
공용 이름 |
|
resource_uri
|
objects.resource_uri | string |
리소스 URI |
|
민달팽이
|
objects.slug | string |
고유 이름 |
|
사용자
|
objects.user | string |
작성자 리소스 URI |
|
xframe_allow
|
objects.xframe_allow | boolean |
포함 서명 허용 |
|
xframe_allow_pdf_edit
|
objects.xframe_allow_pdf_edit | boolean |
포함 편집 허용 |
TemplatePdfListResponse
템플릿 목록
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
메타
|
meta | ListMeta |
목록에 대한 메타 정보입니다. |
|
개체
|
objects | array of TemplatePdfResponse |
TemplatePdfResponse
템플릿 세부 정보
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
created
|
created | date-time |
생성됨 |
|
group
|
group | string |
그룹 URI |
|
으로 바뀌었습니다
|
modified | date-time |
수정됨 |
|
파티
|
parties | string |
문서 파티의 JSON 문자열 배열입니다. |
|
page_count
|
page_count | integer |
페이지 수 |
|
resource_uri
|
resource_uri | string |
리소스 URI |
|
signer_count
|
signer_count | integer |
서명자 수 |
|
title
|
title | string |
제목 |
|
사용자
|
user | string |
작성자의 리소스 URI |
|
UUID (범용 고유 식별자)
|
uuid | uuid |
Pdf Id |
|
유효함
|
valid | boolean |
보낼 수 있습니다(필드의 유효성을 검사하지 않는 경우). |
DocumentListResponse
문서 목록
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
메타
|
meta | ListMeta |
목록에 대한 메타 정보입니다. |
|
개체
|
objects | array of object |
문서 |
|
보관
|
objects.archived | boolean |
Archived |
|
auto_archive
|
objects.auto_archive | boolean |
보낸 후 보관합니다. |
|
cc_emails
|
objects.cc_emails | string |
완료 시 참조로 쉼표로 구분된 목록 전자 메일입니다. |
|
created
|
objects.created | date-time |
생성됨 |
|
do_email
|
objects.do_email | boolean |
Legalesign 전자 메일을 사용합니다. |
|
download_final
|
objects.download_final | boolean |
완료 후 다운로드할 준비가 완료되었습니다. |
|
group
|
objects.group | string |
리소스 URI를 그룹화합니다. |
|
으로 바뀌었습니다
|
objects.modified | date-time |
수정됨 |
|
이름
|
objects.name | string |
문서 이름 |
|
pdftext
|
objects.pdftext | string |
보낸 사람 필드 값 |
|
리디렉션할
|
objects.redirect | string |
서명 후 받는 사람을 리디렉션하는 URL |
|
resource_uri
|
objects.resource_uri | string |
리소스 URI |
|
return_signer_links
|
objects.return_signer_links | boolean |
응답에 받는 사람 링크 추가 |
|
서명자
|
objects.signers | array of array |
서명자 세부 정보가 있는 중첩된 배열 |
|
items
|
objects.signers | array of |
항상 [서명자 URI, 이름, 성, 전자 메일, sms 번호, has_fields, 상태, 서명자 순서(0-인덱싱됨)]를 포함합니다. |
|
signers_in_order
|
objects.signers_in_order | integer |
이메일 받는 사람 시뮬레이션 또는 순차적으로 |
|
status
|
objects.status | DocumentStatusEnum |
문서 상태 옵션:
|
|
tag
|
objects.tag | string |
문서 태그 |
|
tag1
|
objects.tag1 | string |
문서 태그 |
|
tag2
|
objects.tag2 | string |
문서 태그 |
|
템플릿
|
objects.template | string |
사용되는 경우 템플릿 리소스 URI |
|
templatepdf
|
objects.templatepdf | string |
PDF 템플릿 리소스 URI |
|
문자 메시지
|
objects.text | string |
서명 텍스트 |
|
사용자
|
objects.user | string |
작성자 URI |
|
UUID (범용 고유 식별자)
|
objects.uuid | uuid |
문서 ID |
DocumentStatusEnum
문서 상태 옵션:
- 10 - 초기 상태, 보낸 사람/보내지 않은 서명자 상태 확인
- 20 - 필드 완료
- 30 - 서명됨
- 40 - 제거됨(서명 전)
- 50 - 거부됨
문서 상태 옵션:
- 10 - 초기 상태, 보낸 사람/보내지 않은 서명자 상태 확인
- 20 - 필드 완료
- 30 - 서명됨
- 40 - 제거됨(서명 전)
- 50 - 거부됨
SignerResponse
받는 사람 세부 정보
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
문서
|
document | string |
문서 |
|
메일 주소
|
string |
받는 사람 전자 메일 |
|
|
첫 이름
|
first_name | string |
받는 사람 이름 |
|
성_이름
|
last_name | string |
받는 사람 성 |
|
has_fields
|
has_fields | boolean |
받는 사람에게 필드가 있음 |
|
order
|
order | integer |
받는 사람 주문 |
|
resource_uri
|
resource_uri | string |
받는 사람 리소스 URI |
|
status
|
status | SignerStatusEnum |
서명자 상태 옵션:
|
SignerStatusEnum
서명자 상태 옵션:
- 4 - 들여쓰기
- 5 - 전송 예정
- 10 - 보낸 사람
- 15 - 전자 메일 열기
- 20 - 방문
- 30 - 필드 완료
- 35 - 필드 전체 ex 서명
- 39 - 감시가 완료 될 때까지 대기
- 40 - 서명됨
- 50 - 다운로드됨
- 60 - 거부됨
서명자 상태 옵션:
- 4 - 들여쓰기
- 5 - 전송 예정
- 10 - 보낸 사람
- 15 - 전자 메일 열기
- 20 - 방문
- 30 - 필드 완료
- 35 - 필드 전체 ex 서명
- 39 - 감시가 완료 될 때까지 대기
- 40 - 서명됨
- 50 - 다운로드됨
- 60 - 거부됨
DocumentResponseDetail
문서 세부 정보
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
보관
|
archived | boolean |
보관됨 |
|
auto_archive
|
auto_archive | boolean |
서명 후 문서 보관 파일을 보냅니다. |
|
cc_emails
|
cc_emails | string |
서명할 때 전자 메일 알림에서 보낸 사람과 함께 cc'd를 사용할 사람 |
|
created
|
created | date-time |
생성됨 |
|
do_email
|
do_email | boolean |
Legalesign 전자 메일 사용 |
|
download_final
|
download_final | boolean |
최종 PDF를 다운로드할 수 있습니다. |
|
바닥글
|
footer | string |
HTML 문서 - 바닥글 텍스트(사용되는 경우) |
|
footer_height
|
footer_height | integer |
HTMl 문서 - 바닥글의 px 높이(사용되는 경우) |
|
group
|
group | string |
그룹의 리소스 URI |
|
has_fields
|
has_fields | boolean |
문서에 필드가 있음 |
|
hash_value
|
hash_value | string |
최종 문서의 SHA256 체크섬을 사용하여 최종 PDF 다운로드의 유효성을 검사합니다. |
|
머리글
|
header | string |
HTML 문서 - 사용되는 경우 헤더에 대한 텍스트 |
|
header_height
|
header_height | integer |
HTMl 문서 - 사용되는 경우 헤더의 px 높이 |
|
으로 바뀌었습니다
|
modified | date-time |
수정됨 |
|
이름
|
name | string |
문서 이름 |
|
pdf_password
|
pdf_password | string |
PDF 암호 |
|
pdf_password_type
|
pdf_password_type | string |
pdf 암호가 유지되는 경우 |
|
pdftext
|
pdftext | string |
무시합니다. |
|
리디렉션할
|
redirect | string |
서명 후 받는 사람 리디렉션 URL |
|
resource_uri
|
resource_uri | string |
리소스 URI |
|
return_signer_links
|
return_signer_links | boolean |
무시 |
|
sign_mouse
|
sign_mouse | boolean |
무시하다 |
|
sign_time
|
sign_time | date-time |
서명 시간 |
|
sign_type
|
sign_type | boolean |
레거시 |
|
sign_upload
|
sign_upload | boolean |
레거시 |
|
signature_placement
|
signature_placement | integer |
레거시 |
|
signature_type
|
signature_type | integer |
레거시 - 항상 4 |
|
서명자
|
signers | array of array |
서명자 세부 정보가 있는 중첩된 배열 |
|
items
|
signers | array of |
항상 [서명자 URI, 이름, 성, 전자 메일, sms 번호, has_fields, 상태, 서명자 순서(0-인덱싱됨)]를 포함합니다. |
|
signer_objects
|
signer_objects | array of object |
받는 사람 목록 |
|
메일 주소
|
signer_objects.email | string |
전자 메일 |
|
이름
|
signer_objects.firstname | string |
이름 (이름의 첫 부분) |
|
성씨
|
signer_objects.lastname | string |
성(姓) |
|
전화
|
signer_objects.tel | string |
전화 번호 |
|
order
|
signer_objects.order | integer |
서명 순서 |
|
resource_uri
|
signer_objects.resource_uri | string |
리소스 URI |
|
역할
|
signer_objects.role | string |
역할 |
|
status
|
signer_objects.status | integer |
받는 사람 상태 코드 |
|
UUID (범용 고유 식별자)
|
signer_objects.uuid | string |
받는 사람 ID |
|
signers_in_order
|
signers_in_order | boolean |
이메일 받는 사람 시뮬레이션 또는 순차적으로 |
|
status
|
status | DocumentStatusEnum |
문서 상태 옵션:
|
|
tag
|
tag | string |
참조 |
|
tag1
|
tag1 | string |
참조 |
|
tag2
|
tag2 | string |
참조 |
|
템플릿
|
template | string |
텍스트 템플릿에 대한 리소스 URI(사용되는 경우) |
|
templatepdf
|
templatepdf | string |
사용하는 경우 pdf 서식 파일의 리소스 URI |
|
문자 메시지
|
text | string |
문서 텍스트(사용되는 경우) |
|
사용자
|
user | string |
사용자 리소스 URI입니다. |
|
UUID (범용 고유 식별자)
|
uuid | uuid |
문서 ID |
MemberListResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
메타
|
meta | ListMeta |
목록에 대한 메타 정보입니다. |
|
개체
|
objects | array of MemberResponse |
MemberResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
created
|
created | date-time |
생성됨 |
|
group
|
group | string |
그룹 리소스 URI |
|
으로 바뀌었습니다
|
modified | date-time |
수정됨 |
|
허가
|
permission | PermissionsEnum |
사용 권한 옵션 |
|
resource_uri
|
resource_uri | string |
리소스 URI |
|
사용자
|
user | string |
사용자 리소스 URI입니다. |
AttachmentResponse
항목을 첨부합니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
created
|
created | date-time |
생성됨 |
|
description
|
description | string |
Description |
|
filename
|
filename | string |
파일 이름 |
|
group
|
group | string |
그룹 |
|
resource_uri
|
resource_uri | string |
리소스 URI 연결 |
|
사용자
|
user | string |
사용자 리소스 URI |
|
UUID (범용 고유 식별자)
|
uuid | uuid |
ID 연결 |
AttachmentListResponse
첨부 파일 목록
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
메타
|
meta | ListMeta |
목록에 대한 메타 정보입니다. |
|
개체
|
objects | array of object |
목록 |
|
created
|
objects.created | date-time |
생성됨 |
|
description
|
objects.description | string |
Description |
|
filename
|
objects.filename | string |
파일 이름 |
|
group
|
objects.group | string |
그룹 |
|
resource_uri
|
objects.resource_uri | string |
리소스 URI |
|
사용자
|
objects.user | string |
사용자 리소스 URI |
|
UUID (범용 고유 식별자)
|
objects.uuid | uuid |
ID 연결 |
UserDetailResponse
사용자의 세부 정보입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
date_joined
|
date_joined | date-time |
조인된 날짜 |
|
메일 주소
|
전자 메일 |
||
|
첫 이름
|
first_name | string |
이름 (이름의 첫 부분) |
|
groups
|
groups | array of string |
이 사용자가 가입한 그룹 목록입니다. |
|
last_login
|
last_login | date-time |
마지막 로그인 |
|
성_이름
|
last_name | string |
성(姓) |
|
resource_uri
|
resource_uri | string |
리소스 URI |
|
시간대
|
timezone | string |
시간대 |
|
사용자 이름
|
username | string |
사용자 이름 |
file
기본 데이터 형식 'file'입니다.