Nitro Sign Enterprise 확인됨(미리 보기)
Nitro Sign Enterprise Verified는 가장 엄격한(간) 국가 규정을 준수하는 방대한 양의 서명 방법을 제공하는 유명한 디지털 서명 솔루션입니다. NSEV를 사용하면 모든 종이 기반 프로세스를 탁월한 사용자 환경으로 엔드투엔드 디지털 흐름으로 변환할 수 있습니다. 원하는 대로 서명 프로세스를 간소화하고, 원하는 비즈니스 애플리케이션에서 직접 모든 유형의 문서를 보내고, 서명하고, 추적합니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | 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) |
| 연락처 | |
|---|---|
| 이름 | Nitro 지원 |
| URL | https://www.gonitro.com/support |
| 전자 메일 | service@gonitro.com |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Nitro Software Belgium NV |
| 웹 사이트 | https://www.gonitro.com |
| 개인 정보 보호 정책 | https://www.gonitro.com/legal/privacy-policy |
| 카테고리 | IT 작업; 생산력 |
Nitro Sign Enterprise Verified Connector
스마트 문서 솔루션 전문가인 Nitro Software는 Nitro Sign Enterprise Verified Connector for Power Automate를 사용할 수 있게 해 줍니다. 커넥터를 사용하면 회사에서 선호하는 Microsoft 365 응용 프로그램에서 직접 디지털 서명이 필요한 문서를 Microsoft Teams에서 Word, SharePoint, Dynamics, OneDrive 등으로 직접 전달할 수 있습니다. Nitro Sign Enterprise Verified - 이전에 Nitro Sign Premium 및 Connective eSignatures라고도 합니다.
필수 조건
커넥터 사용을 시작하려면 Nitro Sign Enterprise Verified에 대한 기존 구독이 필요합니다. Nitro Software의 연락처에 문의하거나 웹 사이트의 도움말 및 지원 페이지 로 이동하여 자격 증명을 받습니다.
문서
이 페이지에서는 사용 가능한 다양한 작업을 자세히 설명하고 이러한 작업을 구현할 수 있는 다양한 방법에 대한 인사이트를 제공합니다.
자세한 내용은 설명서 웹 사이트를 살펴보거나 지원 팀에 문의하여 도움말 및 지원 페이지 또는 지원 사서함( mailto:service@gonitro.com)을 참조하세요. API 설명서는 Postman 형식으로도 사용할 수 있습니다.
이 설명서에서 사용되는 다양한 용어를 설명하는 용어집 을 사용할 수 있습니다.
지원되는 작업
Nitro Sign Enterprise Verified 커넥터는 Nitro Sign Enterprise Verified의 API v4를 기반으로 합니다. API는 외부 애플리케이션이 이 문서에 나열된 기능을 통합하고 사용하여 서명 흐름을 만들고 관리할 수 있도록 하는 REST API입니다.
사용 가능한 작업을 다른 그룹으로 그룹화할 수 있습니다.
| 작업 그룹 | 사용 가능한 작업 |
|---|---|
| Packages | 모든 패키지 가져오기 |
| ID로 패키지 가져오기 | |
| 패키지 상태 가져오기 | |
| 새 패키지 만들기(표준 또는 인스턴트) | |
| ID로 패키지 삭제 | |
| 패키지 상태 업데이트 | |
| 패키지의 만료 날짜 가져오기 | |
| 패키지의 만료 날짜 업데이트 | |
| 서명자 건너뛰기 | |
| 미리 알림 보내기 | |
| 패키지 다운로드 | |
| 패키지의 감사 내역 다운로드 | |
| 문서 | 패키지에 문서 추가 |
| 패키지에서 서명된 문서 다운로드 | |
| 이해관계자 | ID로 관련자 삭제 |
| 패키지의 모든 관련자 가져오기 | |
| 패키지에 관련자 추가 | |
| 프로세스 | 패키지의 모든 프로세스 단계 가져오기 |
| 프로세스 | 패키지 프로세스에 단계 추가 |
| 프로세스 | 패키지의 프로세스 단계 덮어쓰기 |
| 프로세스 | 프로세스 단계의 모든 작업 가져오기 |
| 프로세스 | 프로세스 단계 및 모든 해당 행위자 삭제 |
| 프로세스 | 프로세스 단계에 행위자 추가 |
| 프로세스 | 현재 프로세스 단계의 모든 작업 가져오기 |
| Other | 애플리케이션에서 모든 언어를 사용하도록 설정 |
| 패키지에 할당할 수 있는 모든 테마 가져오기 | |
| 패키지를 할당할 수 있는 모든 문서 그룹 가져오기 | |
| 구성된 모든 서명 방법 가져오기 |
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| Nitro Sign 호스트 | 문자열 | 호스트 및 Nitro Sign 환경의 경로(예: contoso.sign.gonitro.com/esig | 진실 |
| API 사용자 이름 | 시큐어스트링 (보안 문자열) | API에 액세스하기 위한 API 사용자 이름 | 진실 |
| API 암호 | 시큐어스트링 (보안 문자열) | API에 액세스하기 위한 API 암호 | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| ID로 패키지 가져오기 |
ID로 패키지를 검색합니다. |
| ID로 패키지 삭제 |
ID로 패키지를 삭제합니다. |
| ID별로 관련자 삭제 |
ID로 관련자를 삭제합니다. |
| 모든 패키지 가져오기 |
모든 패키지를 가져옵니다. 이러한 패키지는 creationDate별로 정렬됩니다. |
| 모든 프로세스 단계 가져오기 |
패키지에서 수행해야 하는 모든 작업을 가져옵니다. |
| 새 패키지 만들기(표준 또는 인스턴트) |
새 패키지를 만듭니다. 기본적으로 패키지는 초안으로 만들어집니다. 즉시 서명할 준비가 된 인스턴트 패키지를 만들려면 속성을
메모: |
| 서명자 건너뛰기 |
이 호출은 아직 완료되지 않은 모든 서명자를 건너뛰고 상태를 '건너뛰기'로 설정하면 전체 패키지가 '완료됨'으로 표시됩니다. |
| 애플리케이션에서 사용하도록 설정된 모든 언어 검색 |
애플리케이션에서 사용하도록 설정된 모든 언어를 검색합니다. |
| 패키지 다운로드 |
특정 패키지의 모든 문서를 Zip 파일로 다운로드하는 데 사용됩니다. |
| 패키지 미리 알림 보내기 |
회사 정책에 따라 지정된 시간 범위 내에서 문서를 처리해야 할 수 있습니다. "미리 알림 보내기" 호출을 트리거하면 서명하지 않은 모든 사용자를 조회하고 추가 알림을 미리 알림으로 보냅니다. |
| 패키지 상태 가져오기 |
패키지의 현재 상태를 검색합니다. |
| 패키지 상태 업데이트 |
패키지의 상태를 업데이트합니다. |
| 패키지 프로세스에 단계 추가 |
패키지 프로세스에 작업 집합을 추가합니다. |
| 패키지를 할당할 수 있는 모든 문서 그룹 검색 |
패키지를 할당할 수 있는 모든 문서 그룹을 검색합니다. |
| 패키지에 관련자 추가 |
패키지에 관련자를 추가합니다. |
| 패키지에 문서 추가 |
기존 패키지에 문서를 추가합니다. |
| 패키지에 할당할 수 있는 모든 테마 검색 |
패키지에 할당할 수 있는 모든 테마를 검색합니다. MaxQuantity 및 continuationToken을 제공하여 결과를 페이징할 수 있습니다. |
| 패키지에서 문서 다운로드 |
패키지에서 서명된 문서를 다운로드합니다. 각 문서는 PDF 또는 XML 파일로 다운로드됩니다. |
| 패키지의 감사 내역 다운로드 |
패키지의 수명에 대한 서명된 감사 내역을 다운로드합니다. |
| 패키지의 만료 날짜 가져오기 |
패키지의 만료 날짜 검색 |
| 패키지의 만료 날짜 업데이트 |
패키지의 만료 날짜 업데이트 |
| 패키지의 모든 관련자 가져오기 |
패키지의 관련자를 검색합니다. |
| 패키지의 프로세스 단계 덮어쓰기 |
각 행위자 집합이 병렬로 수행할 수 있는 작업인 2D 배열을 사용하여 패키지의 모든 행위자를 덮어씁니다. |
| 프로세스 단계 및 모든 해당 행위자 삭제 |
프로세스 단계와 해당 행위자를 모두 삭제합니다. |
| 프로세스 단계에 행위자 추가 |
프로세스 단계에 행위자를 추가합니다. |
| 프로세스 단계의 모든 작업 가져오기 |
프로세스에서 병렬로 완료할 수 있는 특정 작업 집합을 가져옵니다. |
| 현재 구성된 모든 서명 메서드 반환 |
현재 구성된 모든 서명 메서드를 반환합니다. |
| 현재 프로세스 단계의 모든 작업 가져오기 |
병렬로 완료할 수 있는 현재 작업 집합을 가져옵니다. |
ID로 패키지 가져오기
ID로 패키지를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
반환
ID로 패키지 삭제
ID로 패키지를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
ID별로 관련자 삭제
ID로 관련자를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
|
관련자의 고유 식별자
|
stakeholderId | True | string |
관련자의 고유 식별자 |
모든 패키지 가져오기
모든 패키지를 가져옵니다. 이러한 패키지는 creationDate별로 정렬됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
검색할 페이지 번호
|
pageNumber | integer |
검색할 페이지 번호 |
|
|
페이지당 항목 수
|
pageSize | integer |
페이지당 항목 수 |
|
|
이 날짜 이전에 만든 패키지 반환
|
createdBefore | date-time |
이 날짜 이전에 만든 패키지 반환 |
|
|
이 날짜 이후에 만든 패키지 반환
|
createdAfter | date-time |
이 날짜 이후에 만든 패키지 반환 |
|
|
필터링할 패키지의 상태
|
status | string |
필터링할 패키지의 상태 |
|
|
패키지를 필터링하는 문서 그룹 코드
|
documentGroupCode | string |
패키지를 필터링하는 문서 그룹 코드 |
|
|
필터링할 패키지 초기자의 전자 메일
|
initiator |
필터링할 패키지 초기자의 전자 메일 |
||
|
필터링할 패키지의 이름
|
packageName | string |
필터링할 패키지의 이름 |
|
|
패키지 필터링에 대한 외부 참조
|
externalReference | string |
패키지 필터링에 대한 외부 참조 |
|
|
결과를 정렬하는 방법을 지정합니다. 기본값은 내림차순입니다.
|
sort | string |
결과를 정렬하는 방법을 지정합니다. 기본값은 내림차순입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
PageNumber
|
PageNumber | integer |
현재 페이지 번호 |
|
PageSize
|
PageSize | integer |
페이지당 항목 수 |
|
TotalPages
|
TotalPages | integer |
총 페이지 수 |
|
TotalItems
|
TotalItems | integer |
총 항목 수 |
|
아이템
|
Items | array of Response.Package.Get |
모든 프로세스 단계 가져오기
패키지에서 수행해야 하는 모든 작업을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
|
array of array | ||
|
items
|
array of Response.Actor |
프로세스 단계의 행위자 집합입니다. |
새 패키지 만들기(표준 또는 인스턴트)
새 패키지를 만듭니다. 기본적으로 패키지는 초안으로 만들어집니다. 즉시 서명할 준비가 된 인스턴트 패키지를 만들려면 속성을 Pending.로 설정합니다status.
메모:POST /packages 엔드포인트를 사용하면 표준 패키지와 인스턴트 패키지를 모두 만들 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이름
|
Name | True | string |
패키지의 이름 |
|
Initiator
|
Initiator | True |
이메일 주소 |
|
|
ExternalReference
|
ExternalReference | string |
패키지에 대한 외부 참조 |
|
|
상태
|
Status | string |
만든 패키지의 상태입니다.
|
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
패키지에 대한 문서 그룹 코드 |
|
|
ExpiryDate
|
ExpiryDate | date-time |
ISO 8601 형식의 날짜-시간 값 |
|
|
이름
|
Name | True | string |
문서의 이름 |
|
IsOptional
|
IsOptional | boolean |
문서가 서명에 선택 사항이어야 하는지를 나타냅니다. |
|
|
Language
|
Language | True | string |
국가의 2자 ISO 코드(ISO 639-1) |
|
ExternalReference
|
ExternalReference | string |
패키지에 대한 외부 참조 |
|
|
ProofCorrelationId
|
ProofCorrelationId | string |
전역적으로 고유한 식별자 |
|
|
해당 유형
|
TargetType | string |
서버가 문서 변환을 위해 구성된 경우에만 작동합니다. |
|
|
TargetFormat
|
TargetFormat | string |
대상 형식은 추가 변환을 수행해야 하는지를 정의합니다. |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
사소한 결함이 포함된 PDF를 처리하는 방법 |
|
|
콘텐츠 유형
|
ContentType | True | string |
문서의 MIME 형식 |
|
Base64Data
|
Base64Data | True | byte |
Base64로 인코딩된 문서 콘텐츠 |
|
유형
|
Type | True | string |
요소의 형식입니다. |
|
페이지
|
Page | integer |
문서의 페이지 번호 |
|
|
Top
|
Top | number |
픽셀 단위의 위쪽 위치 |
|
|
왼쪽
|
Left | number |
왼쪽 위치(픽셀) |
|
|
너비
|
Width | number |
요소의 너비 |
|
|
높이
|
Height | number |
요소의 높이 |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
이름
|
Name | string |
서명 필드에 추가할 법적 고지의 이름입니다. |
|
|
Content
|
Content | string |
사용자 지정 법적 고지 콘텐츠입니다. |
|
|
유형
|
Type | True | string |
관련자의 유형 |
|
ExternalReference
|
ExternalReference | string |
패키지에 대한 외부 참조 |
|
|
Language
|
Language | True | string |
국가의 2자 ISO 코드(ISO 639-1) |
|
이름 (FirstName)
|
FirstName | string |
관련자의 이름 |
|
|
성씨
|
LastName | True | string |
관련자의 성 |
|
이메일 주소
|
EmailAddress | True |
이메일 주소 |
|
|
생년월일
|
BirthDate | date | ||
|
전화번호
|
PhoneNumber | string |
전화 번호 |
|
|
AdditionalProperties
|
AdditionalProperties | object |
관련자의 구성 가능한 추가 속성 |
|
|
유형
|
Type | True | string |
패키지에서 수행해야 하는 작업 유형 |
|
SuppressNotifications
|
SuppressNotifications | boolean |
행위자 알림 표시 안 함 |
|
|
RedirectUrl
|
RedirectUrl | url |
행위자의 작업이 완료된 후 URL 리디렉션 |
|
|
리디렉션 유형
|
RedirectType | string | ||
|
BackButtonUrl
|
BackButtonUrl | url |
세션을 닫은 후 사용자가 전송되는 URL |
|
|
ProcessStep
|
ProcessStep | integer |
프로세스 단계 번호 |
|
|
DocumentIndex
|
DocumentIndex | True | integer |
패키지의 문서 인덱스(0부터 시작) - 패키지 만들기 엔드포인트에서만 사용 가능 |
|
유형
|
Type | True | string |
요소의 형식입니다. |
|
페이지
|
Page | integer |
문서의 페이지 번호 |
|
|
Top
|
Top | number |
픽셀 단위의 위쪽 위치 |
|
|
왼쪽
|
Left | number |
왼쪽 위치(픽셀) |
|
|
너비
|
Width | number |
요소의 너비 |
|
|
높이
|
Height | number |
요소의 높이 |
|
|
SigningMethods
|
SigningMethods | True | array of string | |
|
이름
|
Name | string |
서명 필드에 추가할 법적 고지의 이름입니다. |
|
|
Content
|
Content | string |
사용자 지정 법적 고지 콘텐츠입니다. |
|
|
ThemeCode
|
ThemeCode | string |
패키지에 대한 테마의 식별자 |
|
|
CallBackUrl
|
CallBackUrl | url |
작업이 수행된 후 콜백에 대한 URL |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | url |
서명자가 새 서명 URL을 요청할 때 콜백 URL |
|
|
DefaultRedirectUrl
|
DefaultRedirectUrl | url |
작업이 완료된 후 URL 리디렉션 |
|
|
F2fRedirectUrl
|
F2fRedirectUrl | url |
대면 서명 후 URL 리디렉션 |
|
|
IsUnsignedContentDownloadable
|
IsUnsignedContentDownloadable | boolean |
서명되지 않은 콘텐츠를 다운로드할 수 있는지 여부 |
|
|
IsReassignEnabled
|
IsReassignEnabled | boolean |
재할당을 사용할 수 있는지 여부 |
반환
서명자 건너뛰기
이 호출은 아직 완료되지 않은 모든 서명자를 건너뛰고 상태를 '건너뛰기'로 설정하면 전체 패키지가 '완료됨'으로 표시됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
애플리케이션에서 사용하도록 설정된 모든 언어 검색
애플리케이션에서 사용하도록 설정된 모든 언어를 검색합니다.
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
EnabledLanguages
|
EnabledLanguages | array of object |
사용하도록 설정된 언어 목록 |
|
디스플레이 이름
|
EnabledLanguages.DisplayName | string |
언어의 표시 이름 |
|
NativeName
|
EnabledLanguages.NativeName | string |
언어의 네이티브 이름 |
|
IsoCultureCode
|
EnabledLanguages.IsoCultureCode | string |
언어의 2자 ISO 코드(ISO 639-1) |
패키지 다운로드
특정 패키지의 모든 문서를 Zip 파일로 다운로드하는 데 사용됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
반환
- response
- binary
패키지 미리 알림 보내기
회사 정책에 따라 지정된 시간 범위 내에서 문서를 처리해야 할 수 있습니다. "미리 알림 보내기" 호출을 트리거하면 서명하지 않은 모든 사용자를 조회하고 추가 알림을 미리 알림으로 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
패키지 상태 가져오기
패키지의 현재 상태를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
반환
패키지 상태 업데이트
패키지의 상태를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
|
body
|
body | True | string |
패키지 프로세스에 단계 추가
패키지 프로세스에 작업 집합을 추가합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
|
유형
|
Type | True | string |
패키지에서 수행해야 하는 작업 유형 |
|
StakeholderId
|
StakeholderId | True | string |
패키지의 관련자 식별자 |
|
SuppressNotifications
|
SuppressNotifications | boolean |
행위자 알림 표시 안 함 |
|
|
RedirectUrl
|
RedirectUrl | url |
행위자의 작업이 완료된 후 URL 리디렉션 |
|
|
아이디
|
Id | string |
기존 요소의 식별자입니다. 사용하는 경우 다른 모든 필드는 비어 있어야 합니다. |
|
|
유형
|
Type | string |
요소의 형식입니다. |
|
|
ExternalReference
|
ExternalReference | string |
패키지에 대한 외부 참조 |
|
|
페이지
|
Page | integer |
문서의 페이지 번호 |
|
|
Top
|
Top | number |
픽셀 단위의 위쪽 위치 |
|
|
왼쪽
|
Left | number |
왼쪽 위치(픽셀) |
|
|
너비
|
Width | number |
요소의 너비 |
|
|
높이
|
Height | number |
요소의 높이 |
|
|
DocumentId
|
DocumentId | string |
패키지에 있는 문서의 식별자 |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
이름
|
Name | string |
서명 필드에 추가할 법적 고지의 이름입니다. |
|
|
Content
|
Content | string |
사용자 지정 법적 고지 콘텐츠입니다. |
|
|
Language
|
Language | string |
국가의 2자 ISO 코드(ISO 639-1) |
반환
프로세스 단계의 행위자 집합입니다.
- response
- array of Response.Actor
패키지를 할당할 수 있는 모든 문서 그룹 검색
패키지를 할당할 수 있는 모든 문서 그룹을 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
검색할 문서 그룹 이름(또는 부분)입니다.
|
name | string |
검색할 문서 그룹 이름(또는 부분)입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
DocumentGroups
|
DocumentGroups | array of object |
문서 그룹 목록 |
|
코드
|
DocumentGroups.Code | string |
문서 그룹의 코드 |
|
이름
|
DocumentGroups.Name | string |
문서 그룹의 이름 |
패키지에 관련자 추가
패키지에 관련자를 추가합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
|
유형
|
Type | True | string |
관련자의 유형 |
|
ExternalReference
|
ExternalReference | string |
패키지에 대한 외부 참조 |
|
|
Language
|
Language | True | string |
국가의 2자 ISO 코드(ISO 639-1) |
|
이름 (FirstName)
|
FirstName | string |
관련자의 이름 |
|
|
성씨
|
LastName | True | string |
관련자의 성 |
|
이메일 주소
|
EmailAddress | True |
이메일 주소 |
|
|
생년월일
|
BirthDate | date | ||
|
전화번호
|
PhoneNumber | string |
전화 번호 |
|
|
AdditionalProperties
|
AdditionalProperties | object |
관련자의 구성 가능한 추가 속성 |
|
|
유형
|
Type | True | string |
패키지에서 수행해야 하는 작업 유형 |
|
SuppressNotifications
|
SuppressNotifications | boolean |
행위자 알림 표시 안 함 |
|
|
RedirectUrl
|
RedirectUrl | url |
행위자의 작업이 완료된 후 URL 리디렉션 |
|
|
리디렉션 유형
|
RedirectType | string | ||
|
BackButtonUrl
|
BackButtonUrl | url |
세션을 닫은 후 사용자가 전송되는 URL |
|
|
아이디
|
Id | string |
기존 요소의 식별자입니다. 사용하는 경우 다른 모든 필드는 비어 있어야 합니다. |
|
|
유형
|
Type | string |
요소의 형식입니다. |
|
|
ExternalReference
|
ExternalReference | string |
패키지에 대한 외부 참조 |
|
|
페이지
|
Page | integer |
문서의 페이지 번호 |
|
|
Top
|
Top | number |
픽셀 단위의 위쪽 위치 |
|
|
왼쪽
|
Left | number |
왼쪽 위치(픽셀) |
|
|
너비
|
Width | number |
요소의 너비 |
|
|
높이
|
Height | number |
요소의 높이 |
|
|
DocumentId
|
DocumentId | string |
패키지에 있는 문서의 식별자 |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
이름
|
Name | string |
서명 필드에 추가할 법적 고지의 이름입니다. |
|
|
Content
|
Content | string |
사용자 지정 법적 고지 콘텐츠입니다. |
|
|
Language
|
Language | string |
국가의 2자 ISO 코드(ISO 639-1) |
반환
패키지에 문서 추가
기존 패키지에 문서를 추가합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지 고유 식별자
|
packageId | True | string |
패키지 고유 식별자 |
|
이름
|
Name | True | string |
문서의 이름 |
|
IsOptional
|
IsOptional | boolean |
문서가 서명에 선택 사항이어야 하는지를 나타냅니다. |
|
|
Language
|
Language | True | string |
국가의 2자 ISO 코드(ISO 639-1) |
|
ExternalReference
|
ExternalReference | string |
패키지에 대한 외부 참조 |
|
|
ProofCorrelationId
|
ProofCorrelationId | string |
전역적으로 고유한 식별자 |
|
|
해당 유형
|
TargetType | string |
서버가 문서 변환을 위해 구성된 경우에만 작동합니다. |
|
|
TargetFormat
|
TargetFormat | string |
대상 형식은 추가 변환을 수행해야 하는지를 정의합니다. |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
사소한 결함이 포함된 PDF를 처리하는 방법 |
|
|
콘텐츠 유형
|
ContentType | True | string |
문서의 MIME 형식 |
|
Base64Data
|
Base64Data | True | byte |
Base64로 인코딩된 문서 콘텐츠 |
|
유형
|
Type | True | string |
요소의 형식입니다. |
|
ExternalReference
|
ExternalReference | string |
패키지에 대한 외부 참조 |
|
|
페이지
|
Page | integer |
문서의 페이지 번호 |
|
|
Top
|
Top | number |
픽셀 단위의 위쪽 위치 |
|
|
왼쪽
|
Left | number |
왼쪽 위치(픽셀) |
|
|
너비
|
Width | number |
요소의 너비 |
|
|
높이
|
Height | number |
요소의 높이 |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
이름
|
Name | string |
서명 필드에 추가할 법적 고지의 이름입니다. |
|
|
Content
|
Content | string |
사용자 지정 법적 고지 콘텐츠입니다. |
|
|
Language
|
Language | string |
국가의 2자 ISO 코드(ISO 639-1) |
반환
패키지에 할당할 수 있는 모든 테마 검색
패키지에 할당할 수 있는 모든 테마를 검색합니다. MaxQuantity 및 continuationToken을 제공하여 결과를 페이징할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
다음 결과 집합을 가져오는 토큰
|
continuationToken | string |
다음 결과 집합을 가져오는 토큰 |
|
|
반환할 결과의 최대 수량
|
maxQuantity | integer |
반환할 결과의 최대 수량 |
|
|
결과를 정렬할 순서
|
sortOrder | string |
결과를 정렬할 순서 |
|
|
정렬할 필드 지정
|
sortField | string |
정렬할 필드 지정 |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
계속 토큰
|
ContinuationToken | string |
결과의 다음 페이지를 검색하기 위한 토큰 |
|
아이템
|
Items | array of object |
테마를 포함하는 목록 |
|
코드
|
Items.Code | string |
테마의 코드 |
|
이름
|
Items.Name | string |
테마의 이름 |
|
MaxQuantity
|
MaxQuantity | integer |
요청당 반환되는 최대 결과 수 |
|
총계
|
Total | integer |
총 결과 수입니다. |
패키지에서 문서 다운로드
패키지에서 서명된 문서를 다운로드합니다. 각 문서는 PDF 또는 XML 파일로 다운로드됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
|
패키지에 포함된 문서의 고유 식별자
|
documentId | True | string |
패키지에 포함된 문서의 고유 식별자 |
반환
- response
- binary
패키지의 감사 내역 다운로드
패키지의 수명에 대한 서명된 감사 내역을 다운로드합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
|
언어 2 문자 ISO 코드(ISO 639-1)
|
culture | True | string |
언어 2 문자 ISO 코드(ISO 639-1) |
반환
- response
- binary
패키지의 만료 날짜 가져오기
패키지의 만료 날짜 검색
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
반환
ISO 8601 형식의 날짜-시간 값
- response
- Common.DateTime
패키지의 만료 날짜 업데이트
패키지의 만료 날짜 업데이트
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
|
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
ISO 8601 형식의 날짜-시간 값 |
패키지의 모든 관련자 가져오기
패키지의 관련자를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
반환
- response
- array of Response.Stakeholder
패키지의 프로세스 단계 덮어쓰기
각 행위자 집합이 병렬로 수행할 수 있는 작업인 2D 배열을 사용하여 패키지의 모든 행위자를 덮어씁니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
|
유형
|
Type | True | string |
패키지에서 수행해야 하는 작업 유형 |
|
StakeholderId
|
StakeholderId | True | string |
패키지의 관련자 식별자 |
|
SuppressNotifications
|
SuppressNotifications | boolean |
행위자 알림 표시 안 함 |
|
|
RedirectUrl
|
RedirectUrl | url |
행위자의 작업이 완료된 후 URL 리디렉션 |
|
|
아이디
|
Id | string |
기존 요소의 식별자입니다. 사용하는 경우 다른 모든 필드는 비어 있어야 합니다. |
|
|
유형
|
Type | string |
요소의 형식입니다. |
|
|
ExternalReference
|
ExternalReference | string |
패키지에 대한 외부 참조 |
|
|
페이지
|
Page | integer |
문서의 페이지 번호 |
|
|
Top
|
Top | number |
픽셀 단위의 위쪽 위치 |
|
|
왼쪽
|
Left | number |
왼쪽 위치(픽셀) |
|
|
너비
|
Width | number |
요소의 너비 |
|
|
높이
|
Height | number |
요소의 높이 |
|
|
DocumentId
|
DocumentId | string |
패키지에 있는 문서의 식별자 |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
이름
|
Name | string |
서명 필드에 추가할 법적 고지의 이름입니다. |
|
|
Content
|
Content | string |
사용자 지정 법적 고지 콘텐츠입니다. |
|
|
Language
|
Language | string |
국가의 2자 ISO 코드(ISO 639-1) |
프로세스 단계 및 모든 해당 행위자 삭제
프로세스 단계와 해당 행위자를 모두 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
|
프로세스 단계의 인덱스
|
stepIndex | True | integer |
프로세스 단계의 인덱스 |
프로세스 단계에 행위자 추가
프로세스 단계에 행위자를 추가합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
|
프로세스 단계의 인덱스
|
stepIndex | True | integer |
프로세스 단계의 인덱스 |
|
유형
|
Type | True | string |
패키지에서 수행해야 하는 작업 유형 |
|
StakeholderId
|
StakeholderId | True | string |
패키지의 관련자 식별자 |
|
SuppressNotifications
|
SuppressNotifications | boolean |
행위자 알림 표시 안 함 |
|
|
RedirectUrl
|
RedirectUrl | url |
행위자의 작업이 완료된 후 URL 리디렉션 |
|
|
아이디
|
Id | string |
기존 요소의 식별자입니다. 사용하는 경우 다른 모든 필드는 비어 있어야 합니다. |
|
|
유형
|
Type | string |
요소의 형식입니다. |
|
|
ExternalReference
|
ExternalReference | string |
패키지에 대한 외부 참조 |
|
|
페이지
|
Page | integer |
문서의 페이지 번호 |
|
|
Top
|
Top | number |
픽셀 단위의 위쪽 위치 |
|
|
왼쪽
|
Left | number |
왼쪽 위치(픽셀) |
|
|
너비
|
Width | number |
요소의 너비 |
|
|
높이
|
Height | number |
요소의 높이 |
|
|
DocumentId
|
DocumentId | string |
패키지에 있는 문서의 식별자 |
|
|
SigningMethods
|
SigningMethods | array of string | ||
|
이름
|
Name | string |
서명 필드에 추가할 법적 고지의 이름입니다. |
|
|
Content
|
Content | string |
사용자 지정 법적 고지 콘텐츠입니다. |
|
|
Language
|
Language | string |
국가의 2자 ISO 코드(ISO 639-1) |
반환
프로세스 단계의 모든 작업 가져오기
프로세스에서 병렬로 완료할 수 있는 특정 작업 집합을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
|
프로세스 단계의 인덱스
|
stepIndex | True | integer |
프로세스 단계의 인덱스 |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
Items | array of Response.Actor |
현재 구성된 모든 서명 메서드 반환
현재 구성된 모든 서명 메서드를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
활성/비활성 서명 메서드만 반환
|
isActive | boolean |
활성/비활성 서명 메서드만 반환 |
반환
- response
- array of ConfiguredSigningMethod
현재 프로세스 단계의 모든 작업 가져오기
병렬로 완료할 수 있는 현재 작업 집합을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
패키지의 고유 식별자
|
packageId | True | string |
패키지의 고유 식별자 |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이템
|
Items | array of Response.Actor |
정의
ConfiguredSigningMethod
eSignatures의 구성된 서명 방법
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
IsActive
|
IsActive | boolean |
새 서명 필드를 만드는 데 signingMethod를 사용할 수 있는지 여부 |
|
이름
|
Name | string |
서명 방법의 구성된 이름 |
|
DisplayNames
|
DisplayNames | object |
서명자에게 표시될 언어별 이름 |
|
DisplayNamesInitiator
|
DisplayNamesInitiator | object |
패키지를 만들 때 초기자에 표시해야 하는 언어별 이름입니다. |
|
설명
|
Descriptions | object |
패키지를 만드는 동안 서명 방법에 대한 자세한 정보를 제공하기 위해 언어별 서명 방법에 대한 설명입니다. |
|
RequiredProperties
|
RequiredProperties | array of string |
위임된 서명에 필요한 속성 |
|
KeyPairs
|
KeyPairs | array of KeyPair |
이 메서드로 서명하는 데 사용할 수 있는 사용 가능한 KeyPairs |
KeyPair
서명 키 쌍 표현
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
이름
|
Name | string |
키 쌍의 이름 |
|
DisplayNames
|
DisplayNames | object |
초기자에 표시될 언어별 이름 |
Common.Guid
Common.EmailAddress
Common.Language
Common.PhoneNumber
Common.ExternalReference
Common.AdditionalProperties
관련자의 구성 가능한 추가 속성
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
|
object |
관련자의 구성 가능한 추가 속성 |
Common.DateTime
Package.Status
Package.Name
Document.Name
Document.Status
Document.DocumentOptions
선택적 문서 매개 변수 정의
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
해당 유형
|
TargetType | string |
서버가 문서 변환을 위해 구성된 경우에만 작동합니다. |
|
TargetFormat
|
PdfOptions.TargetFormat | string |
대상 형식은 추가 변환을 수행해야 하는지를 정의합니다. |
|
PdfErrorHandling
|
PdfOptions.PdfErrorHandling | string |
사소한 결함이 포함된 PDF를 처리하는 방법 |
Stakeholder.FirstName
Stakeholder.LastName
Actor.Type
Actor.Status
Element.Type
Element.Status
Element.Location
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
페이지
|
Page | integer |
문서의 페이지 번호 |
|
Top
|
Top | number |
픽셀 단위의 위쪽 위치 |
|
왼쪽
|
Left | number |
왼쪽 위치(픽셀) |
Element.Dimensions
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
너비
|
Width | number |
요소의 너비 |
|
높이
|
Height | number |
요소의 높이 |
Response.Package.Get
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
Id | Common.Guid |
전역적으로 고유한 식별자 |
|
이름
|
Name | Package.Name |
패키지의 이름 |
|
Initiator
|
Initiator | Common.EmailAddress |
이메일 주소 |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
패키지에 대한 외부 참조 |
|
CreationDate
|
CreationDate | Common.DateTime |
ISO 8601 형식의 날짜-시간 값 |
|
상태
|
Status | Package.Status |
패키지의 상태 |
|
ExpiryDate
|
ExpiryDate | Common.DateTime |
ISO 8601 형식의 날짜-시간 값 |
|
문서
|
Documents | array of Response.Document | |
|
이해관계자
|
Stakeholders | array of Response.Stakeholder |
Response.Document
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
Id | Common.Guid |
전역적으로 고유한 식별자 |
|
상태
|
Status | Document.Status |
문서의 상태 |
|
DocumentOptions
|
DocumentOptions | Document.DocumentOptions |
선택적 문서 매개 변수 정의 |
|
이름
|
Name | Document.Name |
문서의 이름 |
|
Language
|
Language | Common.Language |
국가의 2자 ISO 코드(ISO 639-1) |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
패키지에 대한 외부 참조 |
|
ProofCorrelationId
|
ProofCorrelationId | Common.Guid |
전역적으로 고유한 식별자 |
Response.Stakeholder
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
유형
|
Type | string |
관련자의 유형 |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
패키지에 대한 외부 참조 |
|
아이디
|
Id | Common.Guid |
전역적으로 고유한 식별자 |
|
Language
|
Language | Common.Language |
국가의 2자 ISO 코드(ISO 639-1) |
|
이름 (FirstName)
|
FirstName | Stakeholder.FirstName |
관련자의 이름 |
|
성씨
|
LastName | Stakeholder.LastName |
관련자의 성 |
|
이메일 주소
|
EmailAddress | Common.EmailAddress |
이메일 주소 |
|
생년월일
|
BirthDate | date | |
|
전화번호
|
PhoneNumber | Common.PhoneNumber |
전화 번호 |
|
AdditionalProperties
|
AdditionalProperties | Common.AdditionalProperties |
관련자의 구성 가능한 추가 속성 |
|
Actors
|
Actors | array of Response.Actor |
Response.Actor
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
유형
|
Type | Actor.Type |
패키지에서 수행해야 하는 작업 유형 |
|
아이디
|
Id | Common.Guid |
전역적으로 고유한 식별자 |
|
StakeholderId
|
StakeholderId | Common.Guid |
전역적으로 고유한 식별자 |
|
상태
|
Status | Actor.Status |
행위자의 상태 |
|
SuppressNotifications
|
SuppressNotifications | boolean |
행위자 알림 표시 안 함 |
|
RedirectUrl
|
RedirectUrl | url |
행위자의 작업이 완료된 후 URL 리디렉션 |
|
요소들
|
Elements | array of Response.Element |
Response.Element
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
유형
|
Type | Element.Type |
요소의 형식입니다. |
|
아이디
|
Id | Common.Guid |
전역적으로 고유한 식별자 |
|
ActorId
|
ActorId | Common.Guid |
전역적으로 고유한 식별자 |
|
DocumentId
|
DocumentId | integer |
패키지에 있는 문서의 식별자 |
|
상태
|
Status | Element.Status |
요소의 상태입니다. |
|
ExternalReference
|
ExternalReference | Common.ExternalReference |
패키지에 대한 외부 참조 |
|
위치
|
Location | Element.Location | |
|
치수
|
Dimensions | Element.Dimensions | |
|
SigningMethods
|
SigningMethods | array of string | |
|
UsedSigningMethod
|
UsedSigningMethod | string |
사용된 서명 방법 |
Response.Package.Status
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
Status | Package.Status |
패키지의 상태 |
이진법
기본 데이터 형식 'binary'입니다.