Verified
사용자 지정 문서 서명 프로세스를 만들 수 있도록 하는 확인된 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) |
| Power Automate (파워 오토메이트) | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 연락처 | |
|---|---|
| 이름 | Verified |
| URL | https://verified.eu/en/#about-us |
| 전자 메일 | support@verified.eu |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Crm - Konsulterna i Sverige AB |
| 웹 사이트 | https://verified.eu/ |
| 개인 정보 보호 정책 | https://verified.eu/trust-center |
| 카테고리 | 콘텐츠 및 파일; 생산력 |
확인된 소프트웨어는 전자 식별 및 디지털 서명의 서비스 공급자입니다. 이 커넥터를 사용하면 확인된 API에 통합하고 애플리케이션 내에서 간단하고 직관적인 서명 프로세스를 만들 수 있습니다.
필수 조건
계속하려면 다음이 필요합니다.
- 확인된 계정에 등록
자격 증명을 가져오는 방법
이 커넥터는 기본 인증을 사용합니다. 사용자는 연결을 만들 때 사용자 이름, 암호 및 회사 ID를 제시해야 합니다. 사용자 이름과 암호는 확인된 포털에 로그인하는 데 사용하는 것과 동일합니다. 확인된 포털에 로그인해야 하는 회사 ID를 가져오려면 몇 가지가 있는 경우 올바른 회사를 선택하고 URL에서 회사 ID를 복사합니다.
시작하기
일반적인 사용 사례는 서명 프로세스를 시작하고 관리하는 것입니다. 즉, 확인에 서명할 문서를 보내고 정기적으로 서명된 문서를 다시 가져오기 위한 자동화를 설정하는 것입니다. 확인된 서명 프로세스를 시작하는 데 사용되는 일반적인 작업에는 봉투 만들기 - 설명자 또는 봉투 만들기 - 기본값, 봉투에 문서 추가, 문서에 파일 추가, 봉투에 받는 사람 추가, 봉투에 대한 게시 상태 업데이트 등이 있습니다. 문서의 확인된 상태를 확인하는 데 사용되는 일반적인 작업에는 ID로 봉투 가져오기, 봉투 ID로 모든 문서 가져오기, 문서 ID별 파일 가져오기, ID별 파일 URL 가져오기 등이 있습니다. 작업 생성 보안 토큰은 다음 단계에서 사용할 보안 토큰을 가져오기 위해 항상 첫 번째 단계로 사용됩니다.
알려진 문제 및 제한 사항
현재 알려진 제한 사항은 다음과 같습니다.
- 모든 흐름의 시작 부분에서는 다음 모든 단계에서 다시 사용할 인증 토큰을 만들어야 합니다.
- 문서를 추가하려면 HTTP 요청을 특정 URL로 보내야 합니다.
- 새 검색 엔드포인트를 사용하려면 확인된 Suppoert를 통해 계정에 대해 활성화되어야 합니다.
자주 묻는 질문(FAQ)
문서를 확인에 업로드하려면 어떻게 해야 하나요?
실제 문서를 업로드하려면 확인된 API에서 파일을 만들고 확인된 API에서 응답한 Blob URL에 문서 해시를 업로드해야 합니다.
봉투 ID 가져오기 작업을 사용한 후 봉투를 잡으면 어떻게 하나요?
봉투를 만드는 단계는 봉투의 전체 경로인 uid로 응답합니다(예: "/envelopes/ABCDE"). 다른 단계의 경우 uid의 마지막 부분(예: "ABCDE"의 실제 봉투 ID)만 필요합니다.
이 작업을 수행하는 방법에 대한 예제는 다음과 같습니다.
substring(outputs('Create_new_default_envelope')?['body/uid'],11)
봉투 작업에 문서 추가 작업을 사용한 후 문서 ID를 유지하려면 어떻게 해야 하나요?
문서를 만드는 단계는 머리글에 새 문서의 위치로 응답합니다. 위치는 문서의 전체 경로입니다(예: "/api/envelopes/ABCDE/documents/FGHIJ"). 다음 단계에는 문서 ID(이 경우 FGHIJ)만 필요합니다.
이 작업을 수행하는 방법에 대한 예제는 다음과 같습니다.
substring(outputs('Add_document_to_envelope')?['headers/Location'], add(indexOf(outputs('Add_document_to_envelope')?['headers/Location'], '/documents/'), 11))
봉투에서 흐름 ID를 유지하려면 어떻게 해야 하나요?
봉투에 대한 정보를 로드하면 관련 흐름이 응답의 일부가 됩니다(예: "/flow/default"). 응답에서 흐름의 ID라고 하지만 흐름 상태 가져오기와 같은 다른 단계에서 흐름 ID를 요청하는 경우 마지막 부분만 필요합니다.
이 작업을 수행하는 방법에 대한 예제는 다음과 같습니다.
substring(outputs('Get_envelope_by_id')?['body/flow/id'],6)
새 검색 작업을 어떻게 사용할 수 있나요?
새 검색 작업을 사용하려면 확인된 조직에 대해 검색 엔드포인트를 활성화해야 합니다. 이렇게 하려면 조직 ID를 포함하여 확인된 지원에 전자 메일을 작성하여 엔드포인트를 활성화해야 합니다.
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| 사용자 이름 | 시큐어스트링 (보안 문자열) | 이 API의 사용자 이름 | 진실 |
| 암호 | 시큐어스트링 (보안 문자열) | 이 API의 암호 | 진실 |
| 회사 ID | 문자열 | 회사 ID는 확인됨으로 제공됩니다. app.verified.eu 로그인하여 URL에서 찾을 수 있습니다. | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| ID로 문서 가져오기 |
지정된 문서의 정보를 가져옵니다. |
| ID로 문서 삭제 |
지정된 문서를 삭제합니다. |
| ID로 받는 사람 업데이트 |
받는 사람을 업데이트합니다. |
| ID로 봉투 가져오기 |
지정된 봉투의 세부 정보를 가져옵니다. |
| ID로 봉투 삭제 |
지정된 봉투를 삭제합니다. |
| ID로 파일 URL 가져오기 |
지정된 파일의 URL을 가져옵니다. |
| ID로 파일 가져오기 |
지정된 파일에 대한 정보를 가져옵니다. |
| ID로 회사 가져오기 |
지정된 회사의 정보를 가져옵니다. |
| ID별 설명자 가져오기 |
지정된 설명자의 정보를 가져옵니다. |
| 기본 설명자 가져오기 |
봉투의 기본 설명자를 가져옵니다. |
| 모든 봉투 검색 |
지정된 필터와 일치하는 모든 봉투를 검색합니다. |
| 모든 봉투 받는 사람 가져오기 |
지정된 봉투의 받는 사람을 모두 가져옵니다. |
| 모든 봉투 쿼리(사용되지 않음) |
지정된 필터와 일치하는 모든 봉투를 쿼리합니다. (더 이상 사용되지 않음) |
| 모든 설명자 가져오기 |
현재 회사에 있는 모든 설명자 목록을 가져옵니다. 목록을 필터링할 수 있습니다. |
| 문서 ID로 파일 가져오기 |
지정된 문서에 연결된 모든 파일을 가져옵니다. |
| 문서 중단 상태 설정 |
지정된 문서의 상태를 중단됨으로 설정합니다. |
| 문서에 파일 추가 |
기존 문서에 파일을 추가합니다. |
| 보안 토큰 생성 |
확인된 API에서 인증 토큰을 가져옵니다. |
| 봉투 ID로 모든 문서 가져오기 |
지정된 봉투와 관련된 모든 문서를 가져옵니다. |
| 봉투 ID로 흐름 상태 가져오기 |
지정된 봉투의 현재 흐름 상태를 가져옵니다. |
| 봉투 만들기 - 기본값 |
기본 설명자를 사용하여 새 봉투를 만듭니다. |
| 봉투 만들기 - 설명자 |
특정 설명자를 기반으로 봉투를 만듭니다. |
| 봉투 설정 업데이트 |
지정된 봉투의 설정을 업데이트합니다. |
| 봉투 중단 상태 설정 |
지정된 봉투의 상태를 중단됨으로 설정합니다. |
| 봉투 휴지통 상태 설정 |
지정된 봉투의 상태를 휴지통으로 설정합니다. |
| 봉투에 대한 게시 상태 업데이트 |
지정된 봉투의 게시 상태를 업데이트합니다. |
| 봉투에 대한 특정 받는 사람 가져오기 |
지정된 봉투에 대한 특정 받는 사람을 가져옵니다. |
| 봉투에 문서 추가 |
기존 봉투에 새 문서를 추가합니다. |
| 봉투에 받는 사람 추가 |
지정된 봉투에 받는 사람을 추가합니다. |
| 사용자 설정 가져오기 |
지정된 사용자의 설정을 가져옵니다. |
| 사용자 정보 가져오기 |
현재 로그인한 사용자의 정보를 가져옵니다. |
| 서명 링크 만들기 |
서명 링크를 만듭니다. 구현은 흐름별로 지정되며 특정 흐름에 대해 누락될 수 있습니다. |
| 서식 파일에서 문서 생성 |
미리 구성된 템플릿에서 문서를 생성합니다. |
| 알림 보내기 |
지정된 봉투의 수용자에게 알림을 보냅니다. |
ID로 문서 가져오기
지정된 문서의 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
문서 ID
|
document-id | True | string |
해당 문서의 ID입니다. |
반환
- 문서
- Document
ID로 문서 삭제
지정된 문서를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
문서 ID
|
document-id | True | string |
해당 문서의 ID입니다. |
ID로 받는 사람 업데이트
받는 사람을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
받는 사람 ID
|
recipient-id | True | string |
해당 받는 사람의 ID입니다. |
|
이름 (First Name)
|
givenName | True | string | |
|
성 이름
|
familyName | True | string | |
|
Language
|
language | True | string | |
|
서명 방법
|
signingMethod | True | string | |
|
Notification 메서드
|
notificationMethod | string | ||
|
전자 메일
|
True | string | ||
|
전화
|
telephone | string |
형식은 +<countryCode><전화 번호여야 합니다.> |
|
|
순서
|
order | integer | ||
|
조치
|
action | True | string |
받는 사람이 실행해야 하는 작업의 이름이 확인되었습니다. |
|
라벨
|
label | True | string |
받는 사람의 역할/작업에 대한 레이블 |
|
이름
|
name | True | string |
받는 사람 역할의 확인된 이름 |
|
Secure
|
secure | boolean | ||
|
문자 메시지
|
sms | boolean | ||
|
주민등록번호
|
ssn | string | ||
|
은행
|
bank | string |
ID로 봉투 가져오기
지정된 봉투의 세부 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
반환
- 봉투
- Envelope
ID로 봉투 삭제
지정된 봉투를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
ID로 파일 URL 가져오기
지정된 파일의 URL을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
문서 ID
|
document-id | True | string |
해당 문서의 ID입니다. |
|
파일 ID
|
file-id | True | string |
해당 파일의 ID |
|
As 개체
|
asObject | boolean |
응답이 개체인지 여부를 정의합니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
URL
|
url | string |
파일 URL |
ID로 파일 가져오기
지정된 파일에 대한 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
문서 ID
|
document-id | True | string |
해당 문서의 ID입니다. |
|
파일 ID
|
file-id | True | string |
해당 파일의 ID |
반환
- File
- File
ID로 회사 가져오기
지정된 회사의 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
company-id | True | string |
해당 회사의 ID |
반환
- 회사
- Company
ID별 설명자 가져오기
지정된 설명자의 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
Envelope 설명자 ID
|
envelope-descriptor-id | True | string |
봉투 설명자의 ID |
반환
- 설명자
- Descriptor
기본 설명자 가져오기
봉투의 기본 설명자를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
필터
|
filters | string |
쿼리를 필터링하여 가장 중요한 선택 |
반환
- 설명자
- Descriptor
모든 봉투 검색
지정된 필터와 일치하는 모든 봉투를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
필터
|
filters | string |
쿼리를 필터링하여 가장 중요한 선택 |
|
|
부터
|
from | integer |
날짜부터 |
|
|
한계
|
limit | integer |
제한 금액 |
|
|
Sort
|
sort | string |
정렬 기준 |
반환
- response
- array of EnvelopeDescriptorString
모든 봉투 받는 사람 가져오기
지정된 봉투의 받는 사람을 모두 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
반환
- response
- array of Recipient
모든 봉투 쿼리(사용되지 않음)
지정된 필터와 일치하는 모든 봉투를 쿼리합니다. (더 이상 사용되지 않음)
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
필터
|
filters | string |
쿼리를 필터링하여 가장 중요한 선택 |
|
|
부터
|
from | integer |
날짜부터 |
|
|
한계
|
limit | integer |
제한 금액 |
|
|
Sort
|
sort | string |
정렬 기준 |
반환
- response
- array of EnvelopeDescriptorString
모든 설명자 가져오기
현재 회사에 있는 모든 설명자 목록을 가져옵니다. 목록을 필터링할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
필터
|
filters | string |
쿼리를 필터링하여 가장 중요한 선택 |
반환
- response
- array of Descriptor
문서 ID로 파일 가져오기
지정된 문서에 연결된 모든 파일을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
문서 ID
|
document-id | True | string |
해당 문서의 ID입니다. |
반환
- response
- array of File
문서 중단 상태 설정
지정된 문서의 상태를 중단됨으로 설정합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
문서 ID
|
document-id | True | string |
해당 문서의 ID입니다. |
문서에 파일 추가
기존 문서에 파일을 추가합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
문서 ID
|
document-id | True | string |
해당 문서의 ID입니다. |
|
이름
|
name | True | string | |
|
FileType
|
fileType | True | string | |
|
Hash
|
hash | string |
반환
- File
- File
보안 토큰 생성
확인된 API에서 인증 토큰을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
IP 잠금 없음
|
withoutIpLock | True | integer |
확인된 IP 잠금 활성화 여부(0, 기본값) 여부(1) |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
토큰
|
token | string |
액세스 토큰 |
봉투 ID로 모든 문서 가져오기
지정된 봉투와 관련된 모든 문서를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
반환
- response
- array of Document
봉투 ID로 흐름 상태 가져오기
지정된 봉투의 현재 흐름 상태를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
흐름 ID
|
flow-id | True | string |
문제의 흐름 ID |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
토큰
|
token | string |
봉투 만들기 - 기본값
기본 설명자를 사용하여 새 봉투를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
전자 메일
|
string | |||
|
이름 (First Name)
|
givenName | string | ||
|
성 이름
|
familyName | string | ||
|
자동 미리 알림
|
automaticReminders | number | ||
|
Expiration
|
expiration | string | ||
|
Hash
|
hash | string |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
uid
|
uid | string |
봉투 만들기 - 설명자
특정 설명자를 기반으로 봉투를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
Envelope 설명자 ID
|
envelope-descriptor-id | True | string |
봉투 설명자의 ID |
|
전자 메일
|
string | |||
|
이름 (First Name)
|
givenName | string | ||
|
성 이름
|
familyName | string | ||
|
자동 미리 알림
|
automaticReminders | number | ||
|
Expiration
|
expiration | string | ||
|
Hash
|
hash | string |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
uid
|
uid | string |
봉투 설정 업데이트
지정된 봉투의 설정을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
순차 서명
|
sequentialSigning | boolean | ||
|
인사말
|
greeting | string | ||
|
Expiration
|
expiration | date |
다음 형식의 날짜 2017-02-26T21:59:59.999Z |
|
|
자동 미리 알림
|
automaticReminders | number |
만료 전 X일 |
봉투 중단 상태 설정
지정된 봉투의 상태를 중단됨으로 설정합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
주석
|
comment | string |
봉투 휴지통 상태 설정
지정된 봉투의 상태를 휴지통으로 설정합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
주석
|
comment | string |
봉투에 대한 게시 상태 업데이트
지정된 봉투의 게시 상태를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
출판됨
|
published | True | boolean |
봉투에 대한 특정 받는 사람 가져오기
지정된 봉투에 대한 특정 받는 사람을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
받는 사람 ID
|
recipient-id | True | string |
해당 받는 사람의 ID입니다. |
반환
- Recipient
- Recipient
봉투에 문서 추가
기존 봉투에 새 문서를 추가합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
Hash
|
hash | integer | ||
|
이름
|
name | True | string | |
|
출처
|
source | string |
봉투에 받는 사람 추가
지정된 봉투에 받는 사람을 추가합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
이름 (First Name)
|
givenName | True | string | |
|
성 이름
|
familyName | True | string | |
|
Language
|
language | True | string | |
|
서명 방법
|
signingMethod | True | string | |
|
Notification 메서드
|
notificationMethod | string | ||
|
전자 메일
|
True | string | ||
|
전화
|
telephone | string |
형식은 +<countryCode><전화 번호여야 합니다.> |
|
|
순서
|
order | integer | ||
|
조치
|
action | True | string |
받는 사람이 실행해야 하는 작업의 이름이 확인되었습니다. |
|
라벨
|
label | True | string |
받는 사람의 역할/작업에 대한 레이블 |
|
이름
|
name | True | string |
받는 사람 역할의 확인된 이름 |
|
Secure
|
secure | boolean | ||
|
문자 메시지
|
sms | boolean | ||
|
주민등록번호
|
ssn | string | ||
|
은행
|
bank | string |
사용자 설정 가져오기
지정된 사용자의 설정을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
company-id | True | string |
해당 회사의 ID |
|
사용자 ID
|
user-id | True | string |
해당 사용자의 ID |
반환
- 몸
- Setting
사용자 정보 가져오기
현재 로그인한 사용자의 정보를 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
반환
- 몸
- UserInfo
서명 링크 만들기
서명 링크를 만듭니다. 구현은 흐름별로 지정되며 특정 흐름에 대해 누락될 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
아이디
|
id | string | ||
|
리디렉션
|
redirectTo | uri |
사용자를 서명 후로 리디렉션하는 전체 URL입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
URL
|
getSignLink.recipient.{recipient-id}.url | string |
서식 파일에서 문서 생성
미리 구성된 템플릿에서 문서를 생성합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
문서 ID
|
document-id | True | string |
해당 문서의 ID입니다. |
|
템플릿 ID
|
template-id | True | string |
사용해야 하는 템플릿의 ID입니다. |
|
|
object |
알림 보내기
지정된 봉투의 수용자에게 알림을 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
토큰
|
token | True | string |
'보안 토큰 생성' 작업에서 받은 토큰 |
|
회사 ID
|
x-namespace | string |
작업에 사용해야 하는 회사 ID입니다. /companys/<company id> 형식을 지정합니다. 설정되지 않은 경우 연결 회사 ID로 기본 설정됩니다. |
|
|
봉투 ID
|
envelope-id | True | string |
문제의 봉투 ID |
|
인사말
|
greeting | string | ||
|
받는 사람 ID
|
id | True | string |
알림을 보내야 하는 받는 사람의 ID입니다. |
정의
Setting
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
글로벌
|
global | string | |
|
서명 언어
|
preferences.signatoryLanguage | string | |
|
인사말
|
preferences.greeting | string | |
|
서명 방법
|
preferences.signingMethod | string | |
|
미리 알림 오프셋
|
preferences.reminderOffset | string |
사용자 정보
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
이름 (First Name)
|
givenName | string | |
|
성 이름
|
familyName | string | |
|
전자 메일
|
string | ||
|
Language
|
metadata.language | string | |
|
누락된 암호
|
missingPassword | boolean | |
|
사용
|
isEnabled | boolean | |
|
네임스페이스
|
namespace | string | |
|
활성화됨
|
enabled | boolean | |
|
UID
|
uid | string | |
|
아이디
|
id | string | |
|
역할
|
roles | array of Role | |
|
Validated
|
validated | boolean |
회사
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
이름
|
name | string | |
|
Reg. Number
|
regNumber | string | |
|
생성됨
|
created | string | |
|
수정됨
|
modified | string | |
|
Address
|
address | string | |
|
도시
|
city | string | |
|
우편번호
|
zipCode | string | |
|
로고
|
logo | string | |
|
국가
|
country | string | |
|
UId
|
uid | string | |
|
아이디
|
id | string |
Recipient
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
UID
|
uid | string |
받는 사람 UID |
|
네임스페이스
|
namespace | string |
받는 사람 네임스페이스 |
|
생성됨
|
created | string |
만든 받는 사람 |
|
역할
|
role | RoleActionString | |
|
성 이름
|
familyName | string |
받는 사람 성 |
|
이름 (First Name)
|
givenName | string |
받는 사람 프리스트 이름 |
|
Language
|
language | string |
받는 사람 언어 |
|
전자 메일
|
string |
받는 사람 전자 메일 |
|
|
서명 방법
|
signingMethod | string |
받는 사람 서명 Methid |
|
Notification 메서드
|
notificationMethod | string | |
|
순서
|
order | integer |
받는 사람 주문 |
|
아이디
|
id | string |
받는 사람 ID |
|
수정됨
|
modified | string |
받는 사람이 수정됨 |
|
알림을
|
notified | boolean | |
|
완료됨
|
completed | boolean | |
|
demandAttachment
|
demandAttachment | boolean | |
|
주민등록번호
|
ssn | string | |
|
은행
|
bank | string | |
|
Secure
|
secure | boolean | |
|
문자 메시지
|
sms | boolean | |
|
전화
|
telephone | string | |
|
서명
|
signatures | object | |
|
Notifications
|
notifications | array of Notification |
역할
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
유형
|
action.type | string | |
|
메서드
|
action.methods | array of string | |
|
라벨
|
label | string |
라벨 |
|
음. 맥스
|
numMax | integer |
음. 맥스 |
|
음. 민
|
numMin | integer |
음. 민 |
|
역할 이름
|
roleName | string |
RoleActionString
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
조치
|
action | ActionString |
조치 |
|
라벨
|
label | string |
라벨 |
|
음. 맥스
|
numMax | integer |
음. 맥스 |
|
음. 민
|
numMin | integer |
음. 민 |
|
역할 이름
|
roleName | string |
ActionString
봉투
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
봉투 ID |
|
UID
|
uid | string |
Envelope UID |
|
네임스페이스
|
namespace | string |
Envelope 네임스페이스 |
|
버전
|
version | integer |
봉투 버전 |
|
출판됨
|
published | boolean |
봉투 게시됨 |
|
Complete
|
completed | boolean |
봉투 완료됨 |
|
중단됨
|
aborted | boolean |
Envelope Avorted |
|
휴지통
|
trashed | boolean |
봉투 휴지통 |
|
순차 서명
|
sequentialSigning | boolean | |
|
자폐증 미리 알림
|
automaticReminders | integer | |
|
생성됨
|
created | string |
봉투 생성됨 |
|
수정됨
|
modified | string |
봉투 수정됨 |
|
만료됨
|
expired | boolean |
봉투 만료됨 |
|
Flow
|
flow | Flow | |
|
설명자
|
descriptor | Descriptor | |
|
사람
|
sender | Person | |
|
문서
|
documents | array of Document | |
|
받는 사람
|
recipients | array of Recipient | |
|
태그들
|
tags | array of object | |
|
담당자
|
owners | array of Person |
EnvelopeDescriptorString
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
봉투 ID |
|
UID
|
uid | string |
Envelope UID |
|
네임스페이스
|
namespace | string |
Envelope 네임스페이스 |
|
버전
|
version | integer |
봉투 버전 |
|
출판됨
|
published | boolean |
봉투 게시됨 |
|
Complete
|
completed | boolean |
봉투 완료됨 |
|
중단됨
|
aborted | boolean |
Envelope Avorted |
|
휴지통
|
trashed | boolean |
봉투 휴지통 |
|
순차 서명
|
sequentialSigning | boolean | |
|
자폐증 미리 알림
|
automaticReminders | integer | |
|
생성됨
|
created | string |
봉투 생성됨 |
|
수정됨
|
modified | string |
봉투 수정됨 |
|
만료됨
|
expired | boolean |
봉투 만료됨 |
|
Flow
|
flow | Flow | |
|
설명자
|
descriptor | string |
봉투 설명자 |
|
사람
|
sender | Person | |
|
문서
|
documents | array of Document | |
|
받는 사람
|
recipients | array of Recipient | |
|
태그들
|
tags | array of object | |
|
담당자
|
owners | array of Person |
File
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
파일 ID |
|
URL
|
url | string |
파일 URL |
|
이름
|
name | string |
파일 이름 |
|
마임타입
|
mimeType | string | |
|
파일 형식
|
fileType | string | |
|
스토리지 경로
|
storagePath | string | |
|
에서 업로드됨
|
uploadedAt | string | |
|
생성됨
|
created | string |
만든 파일 |
|
담당자
|
owners | array of object | |
|
UID
|
owners.uid | string |
파일 소유자 UID |
|
아이디
|
owners._id | string |
파일 소유자 ID |
|
네임스페이스
|
namespace | string | |
|
UID
|
uid | string |
파일 UID |
Flow
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
흐름 ID |
|
이름
|
name | string |
흐름 이름 |
설명자
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
이름
|
name | string |
설명자 이름 |
|
버전
|
version | integer |
설명자 버전 |
|
UID
|
uid | string |
설명자 UID |
|
삭제됨
|
deleted | boolean |
설명자 삭제됨 |
|
공개
|
public | boolean |
설명자 공용 |
|
만료됨
|
expired | boolean |
설명자가 만료됨 |
|
아이디
|
id | string |
설명자 ID |
|
필수
|
mandatory | boolean |
설명자 필수 |
|
라벨
|
label | string |
설명자 레이블 |
|
유형
|
type | string |
설명자 형식 |
|
역할
|
roles | array of Role | |
|
담당자
|
owners | array of Person | |
|
Flow
|
flow | Flow | |
|
defaultValues
|
defaultValues | DefaultValues |
defaultValues |
|
Instances
|
instances | array of object |
사람
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
UID
|
uid | string |
Person UID |
|
이름 (First Name)
|
givenName | string |
사람 이름 |
|
성 이름
|
familyName | string |
사람 성 |
|
전자 메일
|
string |
개인 전자 메일 |
|
|
Language
|
language | string |
사람 언어 |
|
순서
|
order | integer |
개인 주문 |
문서
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
라벨
|
label | string |
문서 레이블 |
|
유형
|
type | string |
문서 형식 |
|
Hash
|
hash | integer |
문서 해시 |
|
음. 맥스
|
numMax | integer |
문서 Num. 맥스 |
|
음. 민
|
numMin | integer |
문서 Num. 민 |
|
UID
|
uid | string |
문서 UID |
|
네임스페이스
|
namespace | string |
문서 네임스페이스 |
|
출처
|
source | string |
문서 원본 |
|
생성됨
|
created | string |
만든 문서 |
|
이름
|
name | string |
문서 이름 |
|
아이디
|
id | string |
문서 ID |
|
수정됨
|
modified | string |
수정된 문서 |
|
거절됨
|
rejected | boolean |
거부된 문서 |
|
서명
|
signed | boolean |
서명된 문서 |
|
휴지통
|
trashed | boolean |
휴지통 문서 |
|
중단됨
|
aborted | boolean |
문서 중단됨 |
|
버전
|
version | integer |
문서 버전 |
|
attachments
|
attachments | array of Attachment | |
|
Flow
|
flow | Flow | |
|
roles
|
roles | array of Role | |
|
Template
|
template | Template | |
|
설명자
|
descriptor | Descriptor | |
|
서명
|
signatures | array of Signature |
Attachment
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
라벨
|
label | string |
첨부 파일 레이블 |
|
음. 맥스
|
numMax | integer |
첨부 파일 Num입니다. 맥스 |
|
음. 민
|
numMin | integer |
첨부 파일 Num.Min |
|
Hash
|
hash | integer |
첨부 파일 해시 |
Template
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
유형
|
type | string |
템플릿 유형 |
|
HTML
|
html | string | |
|
PDFHTML
|
pdfHtml | string | |
|
아이디
|
id | string | |
|
UID
|
uid | string | |
|
네임스페이스
|
namespace | string | |
|
버전
|
version | integer | |
|
생성됨
|
created | string | |
|
수정됨
|
modified | string | |
|
수정됨
|
published | boolean | |
|
완료됨
|
completed | boolean | |
|
중단됨
|
aborted | boolean |
Signature
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string | |
|
기원
|
origin | string | |
|
이름 (First Name)
|
givenName | string |
이름 (First Name) |
|
성 이름
|
familyName | string |
성 이름 |
|
전자 메일
|
string |
전자 메일 |
|
|
IP
|
ip | string | |
|
날짜
|
date | string | |
|
상태
|
status | string | |
|
주석
|
comment | string |
DefaultValues
defaultValues
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
사람
|
signer | Person | |
|
사람
|
reviewer | Person |
Notification
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string | |
|
UID
|
uid | string | |
|
네임스페이스
|
namespace | string | |
|
상태
|
status | string | |
|
순서
|
order | integer | |
|
세부 정보
|
details | object | |
|
날짜
|
date | string |