Dokobit Universal API
Dokobit Universal API는 내부적으로, 시스템 내에서 문서에 서명하고, 유럽 전역에서 시스템 외부의 제3자로부터 서명을 수집할 수 있는 다양한 도구입니다. 문서 서명은 계정 없는 Dokobit 서명(초대된 참가자가 Dokobit 포털에 등록하지 않고 문서에 서명할 수 있음) 인터페이스에서 조직의 브랜딩으로 발생합니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | 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) |
| 연락처 | |
|---|---|
| 이름 | Dokobit |
| URL | https://support.dokobit.com |
| 전자 메일 | developers@dokobit.com |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Dokobit |
| 웹 사이트 | https://www.dokobit.com/solutions |
| 개인 정보 보호 정책 | https://www.dokobit.com/compliance/privacy-policy |
| 카테고리 | 생산력 |
Dokobit Universal API는 내부적으로, 시스템 내에서 문서에 서명하고, 유럽 전역에서 시스템 외부의 제3자로부터 서명을 수집할 수 있는 다양한 도구입니다. 문서 서명은 계정 없는 Dokobit 서명(초대된 참가자가 Dokobit 포털에 등록하지 않고 문서에 서명할 수 있음) 인터페이스에서 조직의 브랜딩으로 발생합니다.
필수 조건
Dokobit Universal API를 사용하려면 API 액세스 토큰을 얻기 위해 문의하세요 sales@dokobit.com .
자격 증명을 가져오는 방법
영업에 문의하여 API 액세스 토큰 가져오기
커넥터 시작
- 문서 서명은 'DokobitUniversalAPICreateExternalSigning' 또는 'DokobitUniversalAPICreateInternalSigning' 작업을 사용하여 시작할 수 있습니다. 'DokobitUniversalAPICreateExternalSigning'을 사용하면 참가자에게 서명 초대장이 전송됩니다. 'DokobitUniversalAPICreateInternalSigning'은 사용자를 리디렉션할 수 있는 서명 URL을 생성합니다.
- 그런 다음, 참가자를 추가/제거하거나, 미리 알림을 보내거나, 문서 서명 상태를 확인할 수 있는 해당 작업으로 서명을 관리할 수 있습니다.
- 참가자가 문서에 서명하면 'DokobitUniversalAPIDownloadDocumentExternal' 또는 'DokobitUniversalAPIDownloadDocumentInternal' 작업으로 다운로드할 수 있습니다.
알려진 문제 및 제한 사항
현재 구현은 PDF 파일에서 서명 수집을 지원하며 ASiCe, ADoc, BDoc 또는 EDoc 컨테이너에서 지원됩니다.
일반적인 오류 및 해결
- 파일을 Base64로 인코딩된 파일 콘텐츠로 제공해야 합니다.
- 문서 서명 'Type'을 'pdf'로 설정하면 문서 서명이 시작될 때 단일 PDF 문서가 수락됩니다. 여러 파일의 경우 서명 'Type'을 'asice' 또는 다른 컨테이너 형식으로 설정합니다.
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| API 키 | 시큐어스트링 (보안 문자열) | 이 API의 API 키 | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| e-Delivery |
문서 전자 배달은 Dokobit Universal API와 문서를 안전하게 공유하는 데 사용됩니다. |
| Validation |
Dokobit은 정규화된 전자 서명 및 e-seal 유효성 검사를 위한 eIDAS 인증 서비스 공급자입니다. 유효성 검사를 위해 서명된 파일을 업로드하려면 이 작업을 사용합니다. 지원되는 파일 형식: |
| 내부 서명 만들기 |
내부 서명은 시스템에서 서명 요청을 시작합니다. 이 경우 참가자를 리디렉션해야 하는 경우 서명 URL이 생성됩니다. |
| 내부 서명 삭제 |
문서는 소유자의 계정에서 제거됩니다. 다른 참가자가 계속 액세스할 수 있습니다. |
| 내부 서명 상태 확인 |
서명 상태를 사용하여 문서의 정보를 반환합니다. |
| 내부 서명 업데이트 |
기존 문서 서명의 특성을 업데이트할 수 있습니다. |
| 내부 서명자 삭제 |
표시된 참가자에 대해 문서에 대한 액세스가 취소됩니다. |
| 내부 서명자 추가 |
표시된 참가자는 선택한 역할을 사용하여 문서에 액세스할 수 있습니다. |
| 문서 내부 다운로드 |
서명된 문서를 다운로드합니다. |
| 문서 외부 다운로드 |
서명된 문서를 다운로드합니다. |
| 미리 알림 보내기 |
사용자가 아직 문서에 서명하지 않은 경우에만 참가자에게 미리 알림 전자 메일을 보낼 수 있습니다. 외부 서명 흐름에서만 작동합니다. |
| 서명 봉인 |
문서는 조직의 전자 인감으로 봉인됩니다. 전자 봉인을 위한 적격 인증서를 받으려면 지원 developers@dokobit.com 팀에 문의하세요. |
| 외부 서명 만들기 |
외부 서명은 시스템에서 비동기 서명 요청을 시작합니다. 이 경우 사용자는 서명을 위한 전자 메일을 받고 문서에 서명하면 콜백을 받게 됩니다. |
| 외부 서명 삭제 |
문서는 소유자의 계정에서 제거됩니다. 다른 참가자가 계속 액세스할 수 있습니다. |
| 외부 서명 상태 확인 |
서명 상태를 사용하여 문서의 정보를 반환합니다. |
| 외부 서명 업데이트 |
기존 문서 서명의 특성을 업데이트할 수 있습니다. |
| 외부 서명자 삭제 |
표시된 참가자에 대해 문서에 대한 액세스가 취소됩니다. |
| 외부 서명자 추가 |
표시된 참가자는 선택한 역할을 사용하여 문서에 액세스할 수 있습니다. |
| 유효성 검사 - PDF 보고서 |
PDF로 유효성 검사 보고서를 다운로드합니다. |
| 유효성 검사 - XML 보고서 |
XML에서 유효성 검사 보고서를 다운로드합니다. |
| 유효성 검사 - XML 진단 데이터 |
XML에서 진단 데이터를 다운로드합니다. |
| 유효성 검사 - 자세한 PDF 보고서 |
PDF로 자세한 유효성 검사 보고서를 다운로드합니다. |
e-Delivery
문서 전자 배달은 Dokobit Universal API와 문서를 안전하게 공유하는 데 사용됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
유형
|
type | True | string |
문서 형식입니다. 사용 가능한 값: |
|
이름
|
name | True | string |
사용자에 대해 표시되는 문서 이름입니다. |
|
포스트백 URL
|
postback_url | string |
웹후크를 처리할 시스템의 URL입니다. |
|
|
주석
|
comment | string |
받는 사람을 위한 메시지입니다. |
|
|
이름
|
name | True | string |
파일 이름입니다. |
|
Content
|
content | True | string |
Base64로 인코딩된 파일 콘텐츠입니다. |
|
외부 식별자
|
external_id | True | string |
시스템에서 참가자의 고유 임의 식별자입니다. 고유 임의 식별자가 없는 경우 생성할 수 있습니다. |
|
코드
|
code | True | string |
받는 사람의 개인 코드(국가 ID 번호)입니다. |
|
국가 코드
|
country_code | True | string |
받는 사람의 국가 코드입니다. 개인 코드가 제공되는 경우 필수입니다. 사용 가능한 값: |
|
이메일
|
string |
문서를 보내기 위한 받는 사람의 전자 메일입니다. 휴대폰이 설정되지 않은 경우 필수입니다. |
||
|
Phone
|
phone | string |
문서 SMS를 보내기 위한 받는 사람의 전화 번호입니다. 전자 메일이 설정되지 않은 경우 필수입니다. SMS는 전자 메일이 제공되지 않은 경우에만 전송됩니다. |
|
|
알림 언어
|
notifications_language | string |
알림의 언어를 설정합니다. 사용 가능한 값: |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
|
문서 토큰
|
token | string |
문서 토큰입니다. |
|
받는 사람
|
recipients | array of object |
받는 사람의 정보입니다. |
|
외부 식별자
|
recipients.external_id | string |
시스템에서 참가자의 고유 임의 식별자입니다. |
|
토큰
|
recipients.token | string |
받는 사람의 토큰입니다. |
|
코드
|
recipients.code | string |
받는 사람의 개인 코드(국가 ID 번호)입니다. |
|
국가
|
recipients.country | string |
받는 사람의 국가입니다. |
|
이메일
|
recipients.email | string |
받는 사람의 전자 메일입니다. |
Validation
Dokobit은 정규화된 전자 서명 및 e-seal 유효성 검사를 위한 eIDAS 인증 서비스 공급자입니다. 유효성 검사를 위해 서명된 파일을 업로드하려면 이 작업을 사용합니다. 지원되는 파일 형식: asice, asics,sce, edocbdoc, pdf, p7sxml.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이름
|
name | True | string |
파일 이름입니다. |
|
Content
|
content | True | string |
Base64로 인코딩된 파일 콘텐츠입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
업로드 상태
|
status | string |
업로드 상태입니다. |
|
유효성 검사 토큰
|
token | string |
유효성 검사 토큰입니다. |
내부 서명 만들기
내부 서명은 시스템에서 서명 요청을 시작합니다. 이 경우 참가자를 리디렉션해야 하는 경우 서명 URL이 생성됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
유형
|
type | True | string |
문서 형식입니다. 사용 가능한 값: |
|
이름
|
name | True | string |
사용자에 대해 표시되는 서명 이름입니다. |
|
리디렉션 URI
|
redirect_uri | True | string |
서명이 완료된 후 서명자를 리디렉션하는 데 사용할 리디렉션 URI입니다. |
|
포스트백 URL
|
postback_url | string |
웹후크를 처리할 시스템의 URL입니다. |
|
|
정규화된 서명 필요
|
require_qualified_signatures | boolean |
정규화된 서명으로만 서명할 수 있습니다. 기본값: |
|
|
주석 위치
|
annotation_position | string |
PDF 문서에서 서명 주석의 위치를 선택할 수 있습니다. 사용 가능한 값: |
|
|
주석 개인 코드
|
annotation_personal_code | boolean |
개인 코드로 |
|
|
비디오 식별 허용
|
allow_video_identification | boolean |
비디오 기반 ID를 사용하여 서명할 수 있습니다. 기본값: |
|
|
PDF 평면화
|
flatten_pdf | boolean |
true로 설정하면 양식 필드가 문서 콘텐츠의 일부가 되고 서명 후 편집할 수 없도록 문서가 평면화됩니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
허용되는 서명 방법
|
allowed_signing_methods | array of string |
특정 서명 방법만 허용합니다. 사용 가능한 값: |
|
|
이름
|
name | True | string |
파일 이름입니다. |
|
Content
|
content | True | string |
Base64로 인코딩된 파일 콘텐츠입니다. |
|
외부 식별자
|
external_id | True | string |
시스템에서 참가자의 고유 임의 식별자입니다. 고유 임의 식별자가 없는 경우 생성할 수 있습니다. |
|
역할
|
role | string |
참가자의 역할입니다. 사용 가능한 값: |
|
|
코드
|
code | string |
참가자의 코드입니다. |
|
|
국가 코드
|
country_code | string |
참가자의 국가 코드입니다. 개인 코드가 제공되는 경우 필수입니다. 사용 가능한 값: |
|
|
Phone
|
phone | string |
참가자의 휴대폰입니다. |
|
|
알림 언어
|
language | string |
사용자 인터페이스 언어를 설정합니다. 사용 가능한 값: |
|
|
페이지
|
page | string |
표시되는 PDF 서명 주석의 페이지 인덱스입니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
위쪽에서 위치
|
top | string |
표시되는 PDF 서명 주석의 위쪽에서 위치(포인트 단위)입니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
왼쪽에서 위치
|
left | string |
표시되는 PDF 서명 주석의 왼쪽에서 포인트 단위로 배치합니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
Language
|
language | string |
표시되는 PDF 서명 주석의 언어입니다. PDF 형식 서명에만 적용됩니다. 사용 가능한 값: |
|
|
사용자 지정 이유
|
custom_reason | string |
사용자 지정 서명 이유입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
|
서명 토큰
|
token | string |
서명 토큰입니다. |
|
서명자
|
signers | array of object |
참가자의 정보입니다. |
|
외부 식별자
|
signers.external_id | string |
시스템에서 참가자의 고유 임의 식별자입니다. |
|
토큰
|
signers.token | string |
참가자의 토큰입니다. |
|
리디렉션 URI
|
signers.redirect_uri | string |
서명할 URL입니다. |
내부 서명 삭제
문서는 소유자의 계정에서 제거됩니다. 다른 참가자가 계속 액세스할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
내부 서명 상태 확인
서명 상태를 사용하여 문서의 정보를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
서명 상태
|
status | string |
문서 서명 상태입니다. |
|
이름
|
name | string |
사용자에 대해 표시되는 서명 이름입니다. |
|
유형
|
type | string |
문서 형식입니다. |
|
만든 날짜
|
date_created | string |
문서 서명이 시작된 날짜입니다. |
|
Deadline
|
deadline | date-time |
지정된 표준 시간대 조각을 사용하여 서명 마감일입니다. 예: 2018-11-05T13:15:30Z. |
|
파일 이름
|
filename | string |
파일 이름입니다. |
|
Files
|
files | array of object | |
|
이름
|
files.name | string |
파일 이름입니다. |
|
URL 다운로드
|
files.url | string |
파일 다운로드 URL입니다. |
|
MIME 형식
|
files.mime_type | string |
파일 MIME 형식입니다. |
|
서명자
|
signers | array of object |
참가자 정보입니다. |
|
토큰
|
signers.token | string |
참가자의 토큰입니다. |
|
이름
|
signers.first_name | string |
참가자의 이름입니다. |
|
Surname
|
signers.last_name | string |
참가자의 성입니다. |
|
코드
|
signers.code | string |
참가자의 코드입니다. |
|
국가
|
signers.country | string |
참가자의 국가입니다. |
|
이메일
|
signers.email | string |
참가자의 전자 메일입니다. |
|
유형
|
signers.type | string |
형. |
|
상태
|
signers.status | string |
참가자의 상태입니다. |
내부 서명 업데이트
기존 문서 서명의 특성을 업데이트할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
|
정규화된 서명 필요
|
require_qualified_signatures | boolean |
정규화된 서명으로만 서명할 수 있습니다. 기본값: |
|
|
비디오 식별 허용
|
allow_video_identification | boolean |
비디오 기반 ID를 사용하여 서명할 수 있습니다. 기본값: |
|
|
허용되는 서명 방법
|
allowed_signing_methods | array of string |
특정 서명 방법만 허용합니다. 사용 가능한 값: |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
내부 서명자 삭제
표시된 참가자에 대해 문서에 대한 액세스가 취소됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
|
토큰
|
token | True | string |
참가자의 토큰입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
내부 서명자 추가
표시된 참가자는 선택한 역할을 사용하여 문서에 액세스할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
|
외부 식별자
|
external_id | True | string |
시스템에서 참가자의 고유 임의 식별자입니다. 고유 임의 식별자가 없는 경우 생성할 수 있습니다. |
|
역할
|
role | string |
참가자의 역할입니다. 사용 가능한 값: |
|
|
코드
|
code | string |
참가자의 코드입니다. |
|
|
국가 코드
|
country_code | string |
참가자의 국가 코드입니다. 개인 코드가 제공되는 경우 필수입니다. 사용 가능한 값: |
|
|
Phone
|
phone | string |
참가자의 휴대폰입니다. |
|
|
알림 언어
|
language | string |
사용자 인터페이스 언어를 설정합니다. 사용 가능한 값: |
|
|
페이지
|
page | string |
표시되는 PDF 서명 주석의 페이지 인덱스입니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
위쪽에서 위치
|
top | string |
표시되는 PDF 서명 주석의 위쪽에서 위치(포인트 단위)입니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
왼쪽에서 위치
|
left | string |
표시되는 PDF 서명 주석의 왼쪽에서 포인트 단위로 배치합니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
Language
|
language | string |
표시되는 PDF 서명 주석의 언어입니다. PDF 형식 서명에만 적용됩니다. 사용 가능한 값: |
|
|
사용자 지정 이유
|
custom_reason | string |
사용자 지정 서명 이유입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
|
서명자
|
signers | array of object |
참가자의 정보입니다. |
|
외부 식별자
|
signers.external_id | string |
시스템에서 참가자의 고유 임의 식별자입니다. |
|
토큰
|
signers.token | string |
참가자의 토큰입니다. |
|
이름
|
signers.name | string |
참가자의 이름입니다. |
|
Surname
|
signers.surname | string |
참가자의 성입니다. |
|
이메일
|
signers.email | string |
참가자의 전자 메일입니다. |
|
코드
|
signers.code | string |
참가자의 개인 코드(국가 ID 번호). |
|
국가 코드
|
signers.country_code | string |
참가자의 국가입니다. |
|
역할
|
signers.role | string |
참가자의 역할입니다. |
|
회사
|
signers.company | string |
참가자의 회사입니다. |
|
Position
|
signers.position | string |
참가자의 위치입니다. |
|
Phone
|
signers.phone | string |
참가자의 휴대폰입니다. |
문서 내부 다운로드
서명된 문서를 다운로드합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
반환
- response
- object
문서 외부 다운로드
서명된 문서를 다운로드합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
반환
- response
- object
미리 알림 보내기
사용자가 아직 문서에 서명하지 않은 경우에만 참가자에게 미리 알림 전자 메일을 보낼 수 있습니다. 외부 서명 흐름에서만 작동합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
|
서명자 토큰
|
signer | True | string |
참가자의 토큰입니다. |
|
Message
|
message | string |
서명자에게 미리 알림 메시지입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
서명 봉인
문서는 조직의 전자 인감으로 봉인됩니다. 전자 봉인을 위한 적격 인증서를 받으려면 지원 developers@dokobit.com 팀에 문의하세요.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
|
사용자 지정 이유
|
custom_reason | string |
사용자 지정 서명 이유입니다. |
|
|
페이지
|
page | string |
표시되는 PDF 서명 주석의 페이지 인덱스입니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
위쪽에서 위치
|
top | string |
표시되는 PDF 서명 주석의 위쪽에서 위치(포인트 단위)입니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
왼쪽에서 위치
|
left | string |
표시되는 PDF 서명 주석의 왼쪽에서 포인트 단위로 배치합니다. PDF 형식 서명에만 적용됩니다. 기본값: |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
외부 서명 만들기
외부 서명은 시스템에서 비동기 서명 요청을 시작합니다. 이 경우 사용자는 서명을 위한 전자 메일을 받고 문서에 서명하면 콜백을 받게 됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
유형
|
type | True | string |
문서 형식입니다. 사용 가능한 값: |
|
이름
|
name | True | string |
사용자에 대해 표시되는 서명 이름입니다. |
|
포스트백 URL
|
postback_url | string |
웹후크를 처리할 시스템의 URL입니다. |
|
|
Deadline
|
deadline | date-time |
지정된 표준 시간대 조각을 사용하여 서명 마감일입니다. 예: 2018-11-05T13:15:30Z. |
|
|
하드 마감일
|
hard_deadline | boolean |
참가자로 |
|
|
정규화된 서명 필요
|
require_qualified_signatures | boolean |
정규화된 서명으로만 서명할 수 있습니다. 기본값: |
|
|
주석 위치
|
annotation_position | string |
PDF 문서에서 서명 주석의 위치를 선택할 수 있습니다. 사용 가능한 값: |
|
|
주석 개인 코드
|
annotation_personal_code | boolean |
개인 코드로 |
|
|
주석
|
comment | string |
참가자를 위한 메시지입니다. |
|
|
비디오 식별 허용
|
allow_video_identification | boolean |
비디오 기반 ID를 사용하여 서명할 수 있습니다. 기본값: |
|
|
문서 저장 허용
|
allow_document_saving | boolean |
사용자가 Dokobit 포털에 문서를 저장하고 추가 작업을 수행할 수 있도록 허용합니다. 기본값: |
|
|
PDF 평면화
|
flatten_pdf | boolean |
true로 설정하면 양식 필드가 문서 콘텐츠의 일부가 되고 서명 후 편집할 수 없도록 문서가 평면화됩니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
허용되는 서명 방법
|
allowed_signing_methods | array of string |
특정 서명 방법만 허용합니다. 사용 가능한 값: |
|
|
이름
|
name | True | string |
파일 이름입니다. |
|
Content
|
content | True | string |
Base64로 인코딩된 파일 콘텐츠입니다. |
|
외부 식별자
|
external_id | True | string |
시스템에서 참가자의 고유 임의 식별자입니다. 고유 임의 식별자가 없는 경우 생성할 수 있습니다. |
|
이름
|
name | string |
참가자의 이름입니다. |
|
|
Surname
|
surname | string |
참가자의 성입니다. |
|
|
이메일
|
string |
참가자의 전자 메일입니다. |
||
|
코드
|
code | string |
참가자의 개인 코드(국가 ID 번호). |
|
|
국가 코드
|
country_code | string |
참가자의 국가 코드입니다. 개인 코드가 제공되는 경우 필수입니다. 사용 가능한 값: |
|
|
역할
|
role | string |
참가자의 역할입니다. 사용 가능한 값: |
|
|
회사
|
company | string |
참가자의 회사 이름입니다. |
|
|
Position
|
position | string |
참가자의 위치입니다. |
|
|
Phone
|
phone | string |
참가자의 전화 번호입니다. |
|
|
순서
|
sequence | integer |
문서 승인 및 서명 작업의 순서를 설정할 수 있습니다. |
|
|
알림 언어
|
notifications_language | string |
알림의 언어를 설정합니다. 사용 가능한 값: |
|
|
사용자 지정 이유
|
custom_reason | string |
사용자 지정 서명 이유입니다. |
|
|
페이지
|
page | string |
표시되는 PDF 서명 주석의 페이지 인덱스입니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
위쪽에서 위치
|
top | string |
표시되는 PDF 서명 주석의 위쪽에서 위치(포인트 단위)입니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
왼쪽에서 위치
|
left | string |
표시되는 PDF 서명 주석의 왼쪽에서 포인트 단위로 배치합니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
Language
|
language | string |
표시되는 PDF 서명 주석의 언어입니다. PDF 형식 서명에만 적용됩니다. 사용 가능한 값: |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
|
서명 토큰
|
token | string |
서명 토큰입니다. |
|
서명자
|
signers | array of object |
참가자의 정보입니다. |
|
외부 식별자
|
signers.external_id | string |
시스템에서 참가자의 고유 임의 식별자입니다. |
|
토큰
|
signers.token | string |
참가자의 토큰입니다. |
|
이름
|
signers.first_name | string |
참가자의 이름입니다. |
|
Surname
|
signers.last_name | string |
참가자의 성입니다. |
|
코드
|
signers.code | string |
참가자의 개인 코드(국가 ID 번호). |
|
국가
|
signers.country | string |
참가자의 국가입니다. |
|
이메일
|
signers.email | string |
참가자의 전자 메일입니다. |
외부 서명 삭제
문서는 소유자의 계정에서 제거됩니다. 다른 참가자가 계속 액세스할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
외부 서명 상태 확인
서명 상태를 사용하여 문서의 정보를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
서명 상태
|
status | string |
문서 서명 상태입니다. |
|
이름
|
name | string |
사용자에 대해 표시되는 서명 이름입니다. |
|
유형
|
type | string |
문서 형식입니다. |
|
만든 날짜
|
date_created | string |
문서 서명이 시작된 날짜입니다. |
|
Deadline
|
deadline | date-time |
지정된 표준 시간대 조각을 사용하여 서명 마감일입니다. 예: 2018-11-05T13:15:30Z. |
|
파일 이름
|
filename | string |
파일 이름입니다. |
|
Files
|
files | array of object | |
|
이름
|
files.name | string |
파일 이름입니다. |
|
URL 다운로드
|
files.url | string |
파일 다운로드 URL입니다. |
|
MIME 형식
|
files.mime_type | string |
파일 MIME 형식입니다. |
|
서명자
|
signers | array of object |
참가자 정보입니다. |
|
토큰
|
signers.token | string |
참가자의 토큰입니다. |
|
이름
|
signers.first_name | string |
참가자의 이름입니다. |
|
Surname
|
signers.last_name | string |
참가자의 성입니다. |
|
코드
|
signers.code | string |
참가자의 코드입니다. |
|
국가
|
signers.country | string |
참가자의 국가입니다. |
|
이메일
|
signers.email | string |
참가자의 전자 메일입니다. |
|
유형
|
signers.type | string |
형. |
|
상태
|
signers.status | string |
참가자의 상태입니다. |
외부 서명 업데이트
기존 문서 서명의 특성을 업데이트할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
|
Deadline
|
deadline | date-time |
지정된 표준 시간대 조각을 사용하여 서명 마감일입니다. 예: 2018-11-05T13:15:30Z. |
|
|
하드 마감일
|
hard_deadline | boolean |
참가자로 |
|
|
정규화된 서명 필요
|
require_qualified_signatures | boolean |
정규화된 서명으로만 서명할 수 있습니다. 기본값: |
|
|
비디오 식별 허용
|
allow_video_identification | boolean |
비디오 기반 ID를 사용하여 서명할 수 있습니다. 기본값: |
|
|
문서 저장 허용
|
allow_document_saving | boolean |
사용자가 Dokobit 포털에 문서를 저장하고 추가 작업을 수행할 수 있도록 허용합니다. 기본값: |
|
|
허용되는 서명 방법
|
allowed_signing_methods | array of string |
특정 서명 방법만 허용합니다. 사용 가능한 값: |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
외부 서명자 삭제
표시된 참가자에 대해 문서에 대한 액세스가 취소됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
|
토큰
|
token | True | string |
참가자의 토큰입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
외부 서명자 추가
표시된 참가자는 선택한 역할을 사용하여 문서에 액세스할 수 있습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
서명 토큰
|
token | True | string |
서명 토큰입니다. |
|
외부 식별자
|
external_id | True | string |
시스템에서 참가자의 고유 임의 식별자입니다. 고유 임의 식별자가 없는 경우 생성할 수 있습니다. |
|
이름
|
name | string |
참가자의 이름입니다. |
|
|
Surname
|
surname | string |
참가자의 성입니다. |
|
|
이메일
|
string |
참가자의 전자 메일입니다. |
||
|
코드
|
code | string |
참가자의 코드입니다. |
|
|
국가 코드
|
country_code | string |
참가자의 국가 코드입니다. 개인 코드가 제공되는 경우 필수입니다. 사용 가능한 값: |
|
|
역할
|
role | string |
참가자의 역할입니다. 사용 가능한 값: |
|
|
회사
|
company | string |
참가자의 회사입니다. |
|
|
Position
|
position | string |
참가자의 위치입니다. |
|
|
Phone
|
phone | string |
참가자의 휴대폰입니다. |
|
|
사용자 지정 이유
|
custom_reason | string |
사용자 지정 서명 이유입니다. |
|
|
알림 언어
|
notifications_language | string |
알림의 언어를 설정합니다. 사용 가능한 값: |
|
|
페이지
|
page | string |
표시되는 PDF 서명 주석의 페이지 인덱스입니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
위쪽에서 위치
|
top | string |
표시되는 PDF 서명 주석의 위쪽에서 위치(포인트 단위)입니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
왼쪽에서 위치
|
left | string |
표시되는 PDF 서명 주석의 왼쪽에서 포인트 단위로 배치합니다. PDF 형식 서명에만 적용됩니다. 기본값: |
|
|
Language
|
language | string |
표시되는 PDF 서명 주석의 언어입니다. PDF 형식 서명에만 적용됩니다. 사용 가능한 값: |
|
|
주석
|
comment | string |
참가자를 위한 메시지입니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
상태
|
status | string |
상태 |
|
서명자
|
signers | array of object |
참가자의 정보입니다. |
|
외부 식별자
|
signers.external_id | string |
시스템에서 참가자의 고유 임의 식별자입니다. |
|
토큰
|
signers.token | string |
참가자의 토큰입니다. |
|
이름
|
signers.name | string |
참가자의 이름입니다. |
|
Surname
|
signers.surname | string |
참가자의 성입니다. |
|
이메일
|
signers.email | string |
참가자의 전자 메일입니다. |
|
코드
|
signers.code | string |
참가자의 개인 코드(국가 ID 번호). |
|
국가 코드
|
signers.country_code | string |
참가자의 국가입니다. |
|
역할
|
signers.role | string |
참가자의 역할입니다. |
|
회사
|
signers.company | string |
참가자의 회사입니다. |
|
Position
|
signers.position | string |
참가자의 위치입니다. |
|
알림 언어
|
signers.notifications_language | string |
알림의 언어를 설정합니다. 사용 가능한 값: |
|
Phone
|
signers.phone | string |
참가자의 휴대폰입니다. |
유효성 검사 - PDF 보고서
PDF로 유효성 검사 보고서를 다운로드합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
유효성 검사 토큰
|
token | True | string |
DokobitUniversalAPIValidation 작업에서 받은 유효성 검사 토큰입니다. |
반환
- response
- object
유효성 검사 - XML 보고서
XML에서 유효성 검사 보고서를 다운로드합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
유효성 검사 토큰
|
token | True | string |
DokobitUniversalAPIValidation 작업에서 받은 유효성 검사 토큰입니다. |
반환
- response
- object
유효성 검사 - XML 진단 데이터
XML에서 진단 데이터를 다운로드합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
유효성 검사 토큰
|
token | True | string |
DokobitUniversalAPIValidation 작업에서 받은 유효성 검사 토큰입니다. |
반환
- response
- object
유효성 검사 - 자세한 PDF 보고서
PDF로 자세한 유효성 검사 보고서를 다운로드합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
유효성 검사 토큰
|
token | True | string |
DokobitUniversalAPIValidation 작업에서 받은 유효성 검사 토큰입니다. |
반환
- response
- object
정의
객체
'object' 형식입니다.