다음을 통해 공유

BlueInk

Blueink 커넥터를 사용하면 Blueink의 eSignature 플랫폼을 자동화된 워크플로에 추가할 수 있습니다. 커넥터를 사용하면 번들 상태를 확인하고, 새 번들을 만들고, 서명자 정보에 액세스할 수 있습니다.

이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.

서비스 클래스 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)
연락처
이름 Blueink 지원
URL https://help.blueink.com/en/
전자 메일 support@blueink.com
커넥터 메타데이터
게시자 Blueink
웹 사이트 https://blueink.com
개인 정보 보호 정책 https://blueink.com/privacy-policy/
카테고리 비즈니스 관리; 생산력

이 다재다능한 커넥터를 통해 사용자는 다양한 Power Automate 커넥터의 기능을 활용하여 Blueink의 강력한 eSignature 솔루션을 워크플로에 원활하게 통합할 수 있습니다. 이러한 통합을 통해 사용자는 문서 번들의 생성 및 배포를 쉽게 자동화할 수 있습니다. 이 커넥터와 다른 커넥터의 조화로운 상호 작용을 오케스트레이션하여 문서 관리 프로세스를 간소화하고, 효율성을 향상시키며, 클라이언트와 관련자를 위한 원활하고 효율적인 문서 서명 환경을 보장할 수 있습니다. 계약 승인을 자동화하거나, 법적 문서를 처리하거나, 다른 컨텍스트에서 서류 작업을 관리하는 경우 이 커넥터는 워크플로를 최적화하고 생산성을 높일 수 있는 강력한 도구를 제공합니다.

필수 조건

이 커넥터를 사용하려면 blueink.com API 사용 계정이 필요합니다.

자격 증명을 가져오는 방법

계정을 만든 후 페이지 왼쪽에 있는 API 단추를 클릭합니다. 프라이빗 API 키에서 API 키 추가 단추를 누릅니다. API 키에 레이블을 지정하고 제출을 누릅니다. API 키를 복사하고 다시 표시되지 않으므로 어딘가에 저장합니다.

커넥터 시작

Blueink 연결을 처음 만들 때 API 키를 입력하라는 메시지가 표시됩니다. API 키는 항상 토큰 으로 시작한 다음, 만든 API 키를 공백으로 시작해야 합니다. API 키를 입력하는 것은 이 토큰 <API 키>와 같습니다.

인기 있는 작업은 번들을 만드는 것입니다. 번들을 만들려면 복잡한 입력 집합이 필요합니다. 본문 변수의 모양에 https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle 대한 API 설명서를 살펴보세요. 아래 그림은 번들 만들기 본문의 예입니다.

번들 만들기

번들을 만드는 방법에는 여러 가지가 있으며, 만들려는 번들에 맞게 이 JSON을 수정할 수 있습니다. 이 JSON을 수정할 수 있는 더 많은 방법은 API를 살펴보세요. 사용자가 계정에서 설정하는 이전에 만든 템플릿을 사용합니다.

완료된 모든 번들을 나열하는 것은 또 다른 인기 있는 엔드포인트입니다. 번들 목록 작업을 추가한 다음 완료된 번들에 대해 상태 단추를 공동 으로 변경합니다. 이 엔드포인트를 사용하여 완료된 모든 최신 번들을 최신 상태로 유지할 수 있습니다.

번들 나열

알려진 문제 및 제한 사항

번들 만들기 엔드포인트에 본문 JSON이 필요합니다.

일반적인 오류 및 해결

잘못된 토큰 오류로 성공하지 못한 요청에 대한 오류가 발생하는 경우 API 키를 붙여넣고 앞의 토큰 문자열 뒤에 공백을 추가한 다음 API 키를 포함하지 않았는지 확인합니다.

번들을 만들 때 잘못된 입력에 대한 오류가 발생하는 경우 Blueink로 전송되는 유효한 JSON인지 확인합니다.

자주 묻는 질문(FAQ)

1. Blueink란?

  • Blueink는 문서 서명 프로세스를 간소화하여 전자 문서를 안전하게 보내고 서명하고 관리할 수 있는 고급 eSignature 솔루션입니다.

2. Blueink용 Microsoft Connector란?

  • Blueink용 Microsoft Connector는 사용자가 Blueink의 eSignature 솔루션을 Microsoft Power Automate와 원활하게 통합하여 자동화 및 향상된 문서 관리를 가능하게 하는 도구입니다.

3. Blueink용 Microsoft 커넥터는 어떻게 작동하나요?

  • 커넥터를 사용하면 Blueink와 다른 Power Automate 커넥터를 결합하여 자동화된 워크플로를 만들 수 있습니다. 문서 번들의 생성 및 배포를 자동화하여 문서 관리 프로세스를 향상시킬 수 있습니다.

4. Blueink용 Microsoft Connector의 사용 사례는 무엇인가요?

  • 일반적인 사용 사례로는 계약 승인 자동화, 법률 문서 관리, 서류 프로세스 간소화, 고객 및 이해 관계자를 위한 원활하고 효율적인 문서 서명 환경 보장 등이 있습니다.

5. 다른 Microsoft 제품과 함께 Blueink용 Microsoft 커넥터를 사용할 수 있나요?

  • 예, 커넥터는 다양한 Microsoft 제품 및 서비스와 원활하게 작동하도록 설계되어 Blueink eSignatures를 Microsoft 중심 워크플로에 통합할 수 있습니다.

6. Blueink용 Microsoft Connector를 쉽게 설정하고 사용할 수 있나요?

  • 예, 사용자 친화적이며 간단하게 설계되었습니다. 특정 문서 관리 요구 사항에 맞게 워크플로를 구성하고 사용자 지정할 수 있습니다.

7. Blueink용 Microsoft Connector 사용과 관련된 비용이 있나요?

  • 가격 책정은 사용량 및 라이선스 계약에 따라 달라질 수 있습니다. Blueink 또는 Microsoft에 특정 가격 책정 세부 정보를 확인하는 것이 가장 좋습니다.

8. Microsoft Connector for Blueink의 기술 문제에 대한 지원을 받을 수 있나요?

  • 예, Blueink 및 Microsoft는 일반적으로 커넥터 사용과 관련하여 발생할 수 있는 기술 문제 또는 질문을 지원하기 위한 지원 리소스 및 설명서를 제공합니다.

9. Blueink용 Microsoft Connector가 Windows 및 클라우드 기반 Microsoft 서비스와 호환되는가요?

  • 예, 커넥터는 온-프레미스 및 클라우드 기반 Microsoft 서비스와 함께 작동하도록 설계되어 통합 옵션에서 유연성을 제공합니다.

10. Blueink용 Microsoft Connector에 대한 자세한 내용은 어디에서 찾을 수 있나요?

  • 설치 가이드 및 설명서를 비롯한 추가 정보는 Blueink 웹 사이트를 방문하거나 이 커넥터와 관련된 Microsoft Power Automate 설명서를 탐색할 수 있습니다.

연결을 만드는 중

커넥터는 다음 인증 유형을 지원합니다.
기본값 연결을 만들기 위한 매개 변수입니다. 모든 지역 공유할 수 없음

기본값

적용 가능: 모든 지역

연결을 만들기 위한 매개 변수입니다.

공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.

이름 유형 Description 필수
Blueink API 키 시큐어스트링 (보안 문자열) Blueink API 키입니다. API 탭 아래의 Blueink에서 만들 수 있습니다. 올바른 형식은 'Token XXXXXX'입니다. 여기서 XXXXXX는 API 키입니다. 진실

제한 한도

Name 호출 갱신 기간
연결당 API 호출 100 60초

동작

WebhookEvents 나열

BlueInk 계정의 모든 웹후크 이벤트 나열
WebhookEvents 나열

BlueInk 계정의 모든 WebhookDeliveries 나열
WebhookExtraHeader 검색

WebhookExtraHeader의 세부 정보 검색
WebhookExtraHeader 만들기

새 웹후크 헤더 만들기
WebhookExtraHeader 부분 업데이트

웹후크ExtraHeader를 새 데이터로 부분적으로 업데이트합니다.
WebhookExtraHeader 삭제

WebhookExtraHeader 삭제
WebhookExtraHeader 업데이트

WebhookExtraHeader를 새 데이터로 업데이트
WebhookExtraHeaders 나열

BlueInk 계정의 모든 WebhookExtraHeaders 나열
문서 서식 파일 검색

문서 서식 파일 검색
문서 서식 파일 나열

모든 문서 서식 파일 나열
미리 알림 보내기

서명자에게 미리 알림 전자 메일 또는 SMS를 보냅니다. 미리 알림은 한 시간에 한 번만 보낼 수 있습니다. 미리 알림은 배달 방법(전자 메일 또는 SMS)과 이 패킷에 대해 이전에 지정된 전자 메일 주소(또는 전화 번호)로 전송됩니다.
번들 검색

슬러그로 번들 검색
번들 나열

만든 날짜(가장 최근부터 최근까지)로 정렬된 계정의 페이지를 매긴 번들 목록을 반환합니다. 페이지 매김은 페이지 매김 매개 변수를 통해 제어할 수 있습니다(개요->페이지 매김 참조). 쿼리 문자열 필터 매개 변수를 결합할 수 있습니다(예: .). /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention 필터를 결합할 때 모든 필터와 일치하는 번들만 반환됩니다.
번들 데이터 검색

완료된 번들에 대한 필드에 입력된 데이터 가져오기
번들 만들기

서명을 위해 번들 만들기 및 보내기
번들 이벤트 나열

번들과 연결된 이벤트 목록 가져오기
번들 취소

번들 슬러그에 지정된 번들 취소
번들 파일 검색

완료된 번들에 대한 다운로드 가능한 파일 가져오기
번들에 태그 추가

번들에 태그를 더 추가합니다. 번들에 있는 기존 태그는 제거되지 않습니다. 이 호출의 결과는 Bundle.tags가 새 태그 집합과 이전 태그 집합의 결합입니다. 중복 태그는 무시됩니다.
번들에서 태그 제거

번들에서 태그를 제거합니다. 요청에 있는 태그가 번들에 없으면 무시됩니다.
사람 검색

ID로 사람 가져오기
사람 만들기

새 사용자를 만듭니다. 사용자는 BlueInk 사용자와 연결되거나 독립 실행형 사람이 될 수 있습니다. BlueInk 사용자와 연결된 사람을 만들려면 필드를 제공해야 user_id 합니다. 독립 실행형 사용자를 만들려면 필드를 제공해야 name 합니다.
사람 부분 업데이트

사용자를 새 데이터로 부분적으로 업데이트합니다.

개인에 새 전자 메일 또는 전화를 추가하려면 'id' 없이 'channels' 배열에 ContactChannel을 포함합니다.

Person과 연결된 기존 ContactChannel을 업데이트하려면 'id'를 포함합니다. 기존 ContactChannel이 새 전자 메일 또는 휴대폰으로 업데이트됩니다. 그러면 해당 전자 메일(또는 전화)으로 보내는 사용자와 연결된 모든 라이브 번들이 업데이트됩니다.

ContactChannel에 'id'가 포함되지 않지만 전자 메일(또는 전화)이 기존 ContactChannel과 일치하는 경우 해당 ContactChannel은 변경되지 않습니다.
사람 삭제

사람을 삭제합니다. 그러면 연결된 BlueInk 사용자도 삭제됩니다.
사람 업데이트

사용자를 새 데이터로 업데이트합니다. 이 요청에서 생략된 연락처 채널은 모두 삭제됩니다. 사용자의 모든 데이터를 대체하지 않으려면 PATCH를 대신 사용하려고 할 수 있습니다.
웹후크 검색

ID로 웹후크 가져오기
웹후크 공유 비밀 가져오기

웹후크 공유 비밀 가져오기
웹후크 공유 비밀 다시 생성

웹후크 공유 비밀 다시 생성
웹후크 나열

BlueInk 계정의 모든 웹후크 나열
웹후크 만들기

새 웹후크 만들기
웹후크 부분 업데이트

웹후크를 새 데이터로 부분적으로 업데이트합니다.
웹후크 삭제

ID로 웹후크 삭제
웹후크 업데이트

웹후크를 새 데이터로 업데이트합니다. 이 요청에서 생략된 모든 구독은 삭제됩니다. 웹후크의 모든 데이터를 대체하지 않으려면 PATCH를 대신 사용하려고 할 것입니다.
인물 나열

계정의 인물 목록을 가져옵니다. 필요에 따라 검색 쿼리를 제공하여 목록을 필터링할 수 있습니다. 예를 들어 이름이 "John"인 모든 사람을 검색하려면 쿼리 search=John를 사용합니다.
증명 정보 패킷 인증서 검색

이 패킷에 대한 증거 인증서의 링크 및 체크섬 가져오기
패킷 업데이트

새 전자 메일, 전화 번호, 이름 또는 인증 옵션으로 패킷(서명자)을 업데이트합니다.

업데이트된 패킷은 여전히 결과물이어야 합니다. 예를 들어 '전화' 값을 지정 deliver_via 하지만 원래 PacketRequest에 설정된 전화 번호가 없는 경우 이 요청에도 이 요청이 포함되어 phone 야 합니다. 그렇지 않으면 오류가 반환됩니다.

전자 메일 또는 SMS를 통해 배달되도록 원래 포함된 서명(즉, '포함'된 deliver_via)으로 구성된 패킷을 변경할 수 있습니다. 그러나 서명 알림이나 미리 알림은 자동으로 전송되지 않습니다. /packet/{packetId}/remind/를 호출하여 서명 알림 이메일(또는 SMS)을 보내야 합니다.

이 서명자가 개인과 연결된 경우 해당 사용자도 업데이트됩니다. 개인 이름이 변경되고(제공된 경우) 새 전자 메일 또는 전화 번호가 추가됩니다.
포함된 서명 URL 만들기

포함된 서명에 사용할 수 있는 URL 만들기

WebhookEvents 나열

작업 ID:
listWebhookEvents

BlueInk 계정의 모든 웹후크 이벤트 나열

매개 변수

Name 키 필수 형식 Description
웹후크 ID
 webhook uuid

선택한 웹후크 ID와 일치하는 WebhookEvents만 반환됩니다.

예: /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346
이벤트 유형
 event_type string

선택한 event_type 또는 event_types 일치하는 웹후크가 있는 WebhookEvents만 반환됩니다.

예: /webhooks/events/?event_type=bundle_sent/webhooks/events/?event_type__in=bundle_error,bundle_cancelled
상태
 status integer

선택한 상태와 일치하는 WebhookEvent만 반환됩니다.

예: /webhooks/events/?status=1/webhooks/events/?status__in=0,1,2
성공 결과
 success boolean

선택한 성공 상태와 일치하는 WebhookEvent만 반환됩니다.

예: /webhooks/events/?success=true
날짜 범위
 date date-time

날짜 범위 사이에 발생하는 WebhookEvent만 반환됩니다. 참고: 날짜는 YYYY-MM-DD 형식으로 표현됩니다.

예: /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31

반환

Name 경로 형식 Description
array of object
만든
 created date-time
배달
 deliveries array of object
message
 deliveries.message string

문제를 설명하는 메시지
pk(pk)
 deliveries.pk uuid
status
 deliveries.status integer

응답의 상태 메시지, 상태가 없는 경우 0
시간표시
 deliveries.timestamp date-time

배달 시도가 발생한 경우(실패한 경우(예: 시간 제한)가 아니라 시도의 시작)
event_type
 event_type string
payload
 payload string

배달할 때 보낼 페이로드입니다. json
pk(pk)
 pk uuid
status
 status integer

웹후크 엔드포인트에서 마지막 응답의 상태 코드입니다. 0은 응답을 받지 않음을 나타냅니다.
성공
 success boolean
웹후크
 webhook uuid

이벤트가 속한 웹후크를 식별하는 UUID

WebhookEvents 나열

작업 ID:
listWebhookDeliveries

BlueInk 계정의 모든 WebhookDeliveries 나열

매개 변수

Name 키 필수 형식 Description
웹후크 ID
 webhook uuid

선택한 웹후크 ID와 일치하는 WebhookDeliveries만 반환됩니다.

예: /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346
웹후크 이벤트 ID
 webhook_event uuid

선택한 webhook_event ID와 일치하는 WebhookDeliveries만 반환됩니다.

예: /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346
이벤트 유형
 event_type string

선택한 event_type 또는 event_types 일치하는 웹후크가 있는 WebhookDeliveries만 반환됩니다.

예: /webhooks/deliveries/?event_type=bundle_sent/webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled
상태
 status integer

선택한 상태와 일치하는 WebhookDeliveries만 반환됩니다.

예: /webhooks/deliveries/?status=1/webhooks/deliveries/?status__in=0,1,2
날짜 범위
 date date-time

날짜 범위 사이에 발생하는 WebhookDeliveries만 반환됩니다. 참고: 날짜는 YYYY-MM-DD 형식으로 표현됩니다.

예: /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31

반환

Name 경로 형식 Description
array of object
만든
 created date-time
배달
 deliveries array of object
message
 deliveries.message string

문제를 설명하는 메시지
pk(pk)
 deliveries.pk uuid
status
 deliveries.status integer

응답의 상태 메시지, 상태가 없는 경우 0
시간표시
 deliveries.timestamp date-time

배달 시도가 발생한 경우(실패한 경우(예: 시간 제한)가 아니라 시도의 시작)
event_type
 event_type string
payload
 payload string

배달할 때 보낼 페이로드입니다. json
pk(pk)
 pk uuid
status
 status integer

웹후크 엔드포인트에서 마지막 응답의 상태 코드입니다. 0은 응답을 받지 않음을 나타냅니다.
성공
 success boolean
웹후크
 webhook uuid

이벤트가 속한 웹후크를 식별하는 UUID

WebhookExtraHeader 검색

작업 ID:
getWebhookExtraHeader

WebhookExtraHeader의 세부 정보 검색

매개 변수

Name 키 필수 형식 Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

WebhookExtraHeader를 고유하게 식별하는 ID입니다.

반환

Name 경로 형식 Description
아이디
 id uuid
이름
 name string

는 RFC 7230을 준수해야 합니다.
order
 order integer
value
 value string

는 RFC 7230을 준수해야 합니다.
웹후크
 webhook uuid

WebhookExtraHeader 만들기

작업 ID:
createWebhookExtraHeader

새 웹후크 헤더 만들기

매개 변수

Name 키 필수 형식 Description
아이디
 id uuid
이름
 name string

는 RFC 7230을 준수해야 합니다.
order
 order integer
value
 value string

는 RFC 7230을 준수해야 합니다.
웹후크
 webhook uuid

반환

Name 경로 형식 Description
아이디
 id uuid
이름
 name string

는 RFC 7230을 준수해야 합니다.
order
 order integer
value
 value string

는 RFC 7230을 준수해야 합니다.
웹후크
 webhook uuid

WebhookExtraHeader 부분 업데이트

작업 ID:
updateWebhookExtraHeaderPartial

웹후크ExtraHeader를 새 데이터로 부분적으로 업데이트합니다.

매개 변수

Name 키 필수 형식 Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

WebhookExtraHeader를 고유하게 식별하는 ID입니다.
아이디
 id uuid
이름
 name string

는 RFC 7230을 준수해야 합니다.
order
 order integer
value
 value string

는 RFC 7230을 준수해야 합니다.
웹후크
 webhook uuid

반환

Name 경로 형식 Description
아이디
 id uuid
이름
 name string

는 RFC 7230을 준수해야 합니다.
order
 order integer
value
 value string

는 RFC 7230을 준수해야 합니다.
웹후크
 webhook uuid

WebhookExtraHeader 삭제

작업 ID:
deleteWebhookExtraHeader

WebhookExtraHeader 삭제

매개 변수

Name 키 필수 형식 Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

WebhookExtraHeader를 고유하게 식별하는 ID입니다.

WebhookExtraHeader 업데이트

작업 ID:
updateWebhookExtraHeader

WebhookExtraHeader를 새 데이터로 업데이트

매개 변수

Name 키 필수 형식 Description
WebhookExtraHeader ID
 webhookExtraHeaderId True uuid

WebhookExtraHeader를 고유하게 식별하는 ID입니다.
아이디
 id uuid
이름
 name string

는 RFC 7230을 준수해야 합니다.
order
 order integer
value
 value string

는 RFC 7230을 준수해야 합니다.
웹후크
 webhook uuid

반환

Name 경로 형식 Description
아이디
 id uuid
이름
 name string

는 RFC 7230을 준수해야 합니다.
order
 order integer
value
 value string

는 RFC 7230을 준수해야 합니다.
웹후크
 webhook uuid

WebhookExtraHeaders 나열

작업 ID:
listWebhookExtraHeaders

BlueInk 계정의 모든 WebhookExtraHeaders 나열

매개 변수

Name 키 필수 형식 Description
웹후크 ID
 webhook uuid

선택한 웹후크 ID와 일치하는 WebhookExtraHeaders만 반환됩니다.

예: /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346
이벤트 유형
 event_type string

선택한 event_type 또는 event_types 일치하는 웹후크가 있는 WebhookExtraHeaders만 반환됩니다.

예: /webhooks/headers/?event_type=bundle_sent/webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

반환

Name 경로 형식 Description
array of object
아이디
 id uuid
이름
 name string

는 RFC 7230을 준수해야 합니다.
order
 order integer
value
 value string

는 RFC 7230을 준수해야 합니다.
웹후크
 webhook uuid

문서 서식 파일 검색

작업 ID:
retrieveTemplate

문서 서식 파일 검색

매개 변수

Name 키 필수 형식 Description
템플릿 아이디
 templateId True uuid

템플릿을 고유하게 식별하는 ID

반환

Name 경로 형식 Description
fields
 fields array of

문서에 배치된 필드 배열입니다. DocumentTemplate 필드는 DocumentRequest 필드와 약간 다르며, /0> 대신

file_url
 file_url string

이 템플릿의 기초 역할을 하는 원본 파일의 URL입니다.
is_shared
 is_shared boolean

True이면 문서 서식 파일이 공유됩니다. 그렇지 않으면 False
이름
 name string

문서의 이름입니다. 파일 이름 또는 문서가 업로드될 때 기본값으로 설정되지만 사용자에게 친숙한 이름으로 설정할 수 있습니다.
roles
 roles array of object
key
 roles.key string

이 역할을 식별하는 이 문서에 고유한 문자열입니다.
label
 roles.label string

이 역할에 대한 인간 친화적인 레이블

문서 서식 파일 나열

작업 ID:
listTemplates

모든 문서 서식 파일 나열

반환

Name 경로 형식 Description
fields
 fields array of

문서에 배치된 필드 배열입니다. DocumentTemplate 필드는 DocumentRequest 필드와 약간 다르며, /0> 대신

file_url
 file_url string

이 템플릿의 기초 역할을 하는 원본 파일의 URL입니다.
is_shared
 is_shared boolean

True이면 문서 서식 파일이 공유됩니다. 그렇지 않으면 False
이름
 name string

문서의 이름입니다. 파일 이름 또는 문서가 업로드될 때 기본값으로 설정되지만 사용자에게 친숙한 이름으로 설정할 수 있습니다.
roles
 roles array of object
key
 roles.key string

이 역할을 식별하는 이 문서에 고유한 문자열입니다.
label
 roles.label string

이 역할에 대한 인간 친화적인 레이블

미리 알림 보내기

작업 ID:
sendPacketReminder

서명자에게 미리 알림 전자 메일 또는 SMS를 보냅니다. 미리 알림은 한 시간에 한 번만 보낼 수 있습니다. 미리 알림은 배달 방법(전자 메일 또는 SMS)과 이 패킷에 대해 이전에 지정된 전자 메일 주소(또는 전화 번호)로 전송됩니다.

매개 변수

Name 키 필수 형식 Description
패킷 슬러그
 packetId True string

패킷을 고유하게 식별하는 슬러그

번들 검색

작업 ID:
retrieveBundle

슬러그로 번들 검색

매개 변수

Name 키 필수 형식 Description
번들 슬러그
 bundleSlug True string

번들을 고유하게 식별하는 슬러그

번들 나열

작업 ID:
listBundles

만든 날짜(가장 최근부터 최근까지)로 정렬된 계정의 페이지를 매긴 번들 목록을 반환합니다. 페이지 매김은 페이지 매김 매개 변수를 통해 제어할 수 있습니다(개요->페이지 매김 참조). 쿼리 문자열 필터 매개 변수를 결합할 수 있습니다(예: .). /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention 필터를 결합할 때 모든 필터와 일치하는 번들만 반환됩니다.

매개 변수

Name 키 필수 형식 Description
쿼리 검색
 search string

검색 쿼리입니다. 검색과 일치하는 번들만 반환됩니다. 번들에 있는 다음 데이터가 검색됩니다.

  • 번들 슬러그
  • 번들 레이블
  • 번들 custom_key
  • 서명자 이름
  • 서명자 전자 메일
  • 서명자 전화

예: /bundles/?search=foobar@example.com
번들 상태
 status string

번들을 지정된 상태의 번들로 제한합니다.

  • dr: 초안 - 번들은 아직 전송되지 않았습니다.
  • se: Sent - 번들이 전송되었지만 서명자가 아직 시작하지 않았습니다.
  • st: 시작됨 - 하나 이상의 서명자가 문서 검토를 시작했습니다.
  • co: 완료 - 모든 서명자가 검토/서명을 완료했습니다.
  • ca: 취소됨 - 번들 취소됨
  • 예: 만료됨 - 번들은 완료되기 전에 만료되었습니다.
  • fa: 실패 - 오류가 발생하여 번들을 만들거나 완료할 수 없습니다.

예: /bundles/?status=co
번들 상태 목록
 status__in string

지정된 상태 중 하나를 가진 번들로 번들을 제한합니다. 상태는 쉼표로 구분되어야 합니다. 예: /bundles/?status=co,se,st
번들 태그
 tag string

지정된 태그가 있는 번들을 반환합니다. 예: /bundles/?tag=some-tag
번들 태그 목록
 tag__in string

지정된 태그 중 하나 이상이 있는 번들을 반환합니다. 태그는 쉼표로 구분해야 합니다. 예: /bundles/?tag=some-tag,another-tag
번들 정렬 순서
 ordering string

번들의 정렬 순서를 제어합니다. 정렬 순서를 반대로 하려면 "-"가 있는 접두사입니다. 기본적으로 번들은 "-created"로 정렬됩니다. 즉, 번들 생성 날짜부터 가장 최근까지의 번들 만들기 날짜입니다.

반환

Name 경로 형식 Description
array of

번들 데이터 검색

작업 ID:
getBundleData

완료된 번들에 대한 필드에 입력된 데이터 가져오기

매개 변수

Name 키 필수 형식 Description
번들 슬러그
 bundleSlug True string

번들을 고유하게 식별하는 슬러그

반환

Name 경로 형식 Description
array of object
attachments
 attachments array of object

첨부 파일 필드에 대한 파일 첨부 파일 배열 또는 null
내선
 attachments.ext string

파일 확장명입니다.
is_image
 attachments.is_image boolean

이 첨부 파일이 이미지인 경우 true입니다.
이름
 attachments.name string

첨부 파일의 파일 이름
num
 attachments.num integer

파일이 추가된 순서입니다. 단일 첨부 파일 필드에 대한 업로드가 여러 개 있는 경우(예: 웹캠으로 찍은 문서의 각 페이지에 대한 사진)
size
 attachments.size integer

파일 크기(바이트)
url
 attachments.url url

첨부 파일 다운로드에 일시적으로 사용할 수 있는 URL
doc_key
 doc_key string

번들에서 이 문서를 고유하게 식별하는 키(원래 BundleRequest에서)
field_key
 field_key string

Document의 필드를 고유하게 식별하는 키입니다(BundleRequest의 DocumentRequest에 있는 원래 DocumentRequestField에 지정된 대로 또는 DocumentTemplate에 구성된 대로).
filled_by
 filled_by string

이 필드의 값을 입력한 서명자의 패킷 키입니다. 필드 값이 서명자가 편집하지 않은 'initial_value'인 경우 값은 'initial'입니다. 필드 값이 DocumentTemplate에 구성된 기본값인 경우 필러는 'default'입니다.
친절한
 kind string

필드의 종류
label
 label string

필드의 레이블(비어 있을 수 있음)
packet_id
 packet_id

이 필드의 값을 입력한 서명자의 패킷 ID이거나, 서명자가 필드 값을 채우지 않은 경우 null입니다(예: initial_value 또는 defaul 값).
value
 value

필드의 값

번들 만들기

작업 ID:
createBundle

서명을 위해 번들 만들기 및 보내기

매개 변수

Name 키 필수 형식 Description
body
 body

만들 번들을 정의하는 JSON 본문

번들 이벤트 나열

작업 ID:
listBundleEvents

번들과 연결된 이벤트 목록 가져오기

매개 변수

Name 키 필수 형식 Description
번들 슬러그
 bundleSlug True string

번들을 고유하게 식별하는 슬러그

반환

Name 경로 형식 Description
array of object
description
 description string

이벤트의 간단한 소멸
친절한
 kind string

이벤트 종류(2자 코드)
packet_id
 packet_id uuid

패킷의 UUID입니다. 이벤트가 특정 패킷과 연결된 경우에만 존재합니다.
시간표시
 timestamp date-time

이벤트가 발생한 시간입니다.

번들 취소

작업 ID:
cancelBundle

번들 슬러그에 지정된 번들 취소

매개 변수

Name 키 필수 형식 Description
번들 슬러그
 bundleSlug True string

번들을 고유하게 식별하는 슬러그

번들 파일 검색

작업 ID:
getBundleFiles

완료된 번들에 대한 다운로드 가능한 파일 가져오기

매개 변수

Name 키 필수 형식 Description
번들 슬러그
 bundleSlug True string

번들을 고유하게 식별하는 슬러그

반환

Name 경로 형식 Description
array of object
만료
 expires string

ISO 8601 형식의 시간으로 링크가 만료되는 시간
file_url
 file_url string

파일을 다운로드할 수 있는 URL

번들에 태그 추가

작업 ID:
addBundleTags

번들에 태그를 더 추가합니다. 번들에 있는 기존 태그는 제거되지 않습니다. 이 호출의 결과는 Bundle.tags가 새 태그 집합과 이전 태그 집합의 결합입니다. 중복 태그는 무시됩니다.

매개 변수

Name 키 필수 형식 Description
번들 슬러그
 bundleSlug True string

번들을 고유하게 식별하는 슬러그
tags
 tags array of string

태그 배열

번들에서 태그 제거

작업 ID:
removeBundleTags

번들에서 태그를 제거합니다. 요청에 있는 태그가 번들에 없으면 무시됩니다.

매개 변수

Name 키 필수 형식 Description
번들 슬러그
 bundleSlug True string

번들을 고유하게 식별하는 슬러그
tags
 tags array of string

태그 배열

사람 검색

작업 ID:
getPerson

ID로 사람 가져오기

매개 변수

Name 키 필수 형식 Description
개인 ID
 personId True uuid

사용자를 고유하게 식별하는 ID입니다.

반환

Name 경로 형식 Description
channels
 channels array of object
메일 주소
 channels.email email
아이디
 channels.id uuid
친절한
 channels.kind string

전자 메일의 경우 입니다. 전화의 경우 mp입니다.
phone
 channels.phone phone
아이디
 id uuid
is_user
 is_user boolean

True이면 이 사용자가 BlueInk 사용자와 연결됩니다.
metadata
 metadata object

이 사용자와 연결할 메타데이터입니다. SmartFill에서 메타데이터를 사용하여 문서를 자동으로 채울 수 있습니다. 자세한 내용은 SmartFill 설명서를 참조하세요.
이름
 name string

사용자의 이름입니다.

사람 만들기

작업 ID:
createPerson

새 사용자를 만듭니다. 사용자는 BlueInk 사용자와 연결되거나 독립 실행형 사람이 될 수 있습니다. BlueInk 사용자와 연결된 사람을 만들려면 필드를 제공해야 user_id 합니다. 독립 실행형 사용자를 만들려면 필드를 제공해야 name 합니다.

매개 변수

Name 키 필수 형식 Description
메일 주소
 email email
아이디
 id uuid
친절한
 kind string

전자 메일의 경우 입니다. 전화의 경우 mp입니다.
phone
 phone phone
아이디
 id uuid
is_user
 is_user boolean

True이면 이 사용자가 BlueInk 사용자와 연결됩니다.
metadata
 metadata object

이 사용자와 연결할 메타데이터입니다. SmartFill에서 메타데이터를 사용하여 문서를 자동으로 채울 수 있습니다. 자세한 내용은 SmartFill 설명서를 참조하세요.
이름
 name string

사용자의 이름입니다.

반환

Name 경로 형식 Description
channels
 channels array of object
메일 주소
 channels.email email
아이디
 channels.id uuid
친절한
 channels.kind string

전자 메일의 경우 입니다. 전화의 경우 mp입니다.
phone
 channels.phone phone
아이디
 id uuid
is_user
 is_user boolean

True이면 이 사용자가 BlueInk 사용자와 연결됩니다.
metadata
 metadata object

이 사용자와 연결할 메타데이터입니다. SmartFill에서 메타데이터를 사용하여 문서를 자동으로 채울 수 있습니다. 자세한 내용은 SmartFill 설명서를 참조하세요.
이름
 name string

사용자의 이름입니다.

사람 부분 업데이트

작업 ID:
updatePersonPartial

사용자를 새 데이터로 부분적으로 업데이트합니다.

개인에 새 전자 메일 또는 전화를 추가하려면 'id' 없이 'channels' 배열에 ContactChannel을 포함합니다.

Person과 연결된 기존 ContactChannel을 업데이트하려면 'id'를 포함합니다. 기존 ContactChannel이 새 전자 메일 또는 휴대폰으로 업데이트됩니다. 그러면 해당 전자 메일(또는 전화)으로 보내는 사용자와 연결된 모든 라이브 번들이 업데이트됩니다.

ContactChannel에 'id'가 포함되지 않지만 전자 메일(또는 전화)이 기존 ContactChannel과 일치하는 경우 해당 ContactChannel은 변경되지 않습니다.

매개 변수

Name 키 필수 형식 Description
개인 ID
 personId True uuid

사용자를 고유하게 식별하는 ID입니다.
메일 주소
 email email
아이디
 id uuid
친절한
 kind string

전자 메일의 경우 입니다. 전화의 경우 mp입니다.
phone
 phone phone
아이디
 id uuid
is_user
 is_user boolean

True이면 이 사용자가 BlueInk 사용자와 연결됩니다.
metadata
 metadata object

이 사용자와 연결할 메타데이터입니다. SmartFill에서 메타데이터를 사용하여 문서를 자동으로 채울 수 있습니다. 자세한 내용은 SmartFill 설명서를 참조하세요.
이름
 name string

사용자의 이름입니다.

반환

Name 경로 형식 Description
channels
 channels array of object
메일 주소
 channels.email email
아이디
 channels.id uuid
친절한
 channels.kind string

전자 메일의 경우 입니다. 전화의 경우 mp입니다.
phone
 channels.phone phone
아이디
 id uuid
is_user
 is_user boolean

True이면 이 사용자가 BlueInk 사용자와 연결됩니다.
metadata
 metadata object

이 사용자와 연결할 메타데이터입니다. SmartFill에서 메타데이터를 사용하여 문서를 자동으로 채울 수 있습니다. 자세한 내용은 SmartFill 설명서를 참조하세요.
이름
 name string

사용자의 이름입니다.

사람 삭제

작업 ID:
deletePerson

사람을 삭제합니다. 그러면 연결된 BlueInk 사용자도 삭제됩니다.

매개 변수

Name 키 필수 형식 Description
개인 ID
 personId True uuid

사용자를 고유하게 식별하는 ID입니다.

사람 업데이트

작업 ID:
updatePerson

사용자를 새 데이터로 업데이트합니다. 이 요청에서 생략된 연락처 채널은 모두 삭제됩니다. 사용자의 모든 데이터를 대체하지 않으려면 PATCH를 대신 사용하려고 할 수 있습니다.

매개 변수

Name 키 필수 형식 Description
개인 ID
 personId True uuid

사용자를 고유하게 식별하는 ID입니다.
메일 주소
 email email
아이디
 id uuid
친절한
 kind string

전자 메일의 경우 입니다. 전화의 경우 mp입니다.
phone
 phone phone
아이디
 id uuid
is_user
 is_user boolean

True이면 이 사용자가 BlueInk 사용자와 연결됩니다.
metadata
 metadata object

이 사용자와 연결할 메타데이터입니다. SmartFill에서 메타데이터를 사용하여 문서를 자동으로 채울 수 있습니다. 자세한 내용은 SmartFill 설명서를 참조하세요.
이름
 name string

사용자의 이름입니다.

반환

Name 경로 형식 Description
channels
 channels array of object
메일 주소
 channels.email email
아이디
 channels.id uuid
친절한
 channels.kind string

전자 메일의 경우 입니다. 전화의 경우 mp입니다.
phone
 channels.phone phone
아이디
 id uuid
is_user
 is_user boolean

True이면 이 사용자가 BlueInk 사용자와 연결됩니다.
metadata
 metadata object

이 사용자와 연결할 메타데이터입니다. SmartFill에서 메타데이터를 사용하여 문서를 자동으로 채울 수 있습니다. 자세한 내용은 SmartFill 설명서를 참조하세요.
이름
 name string

사용자의 이름입니다.

웹후크 검색

작업 ID:
getWebhook

ID로 웹후크 가져오기

매개 변수

Name 키 필수 형식 Description
웹후크 ID
 webhookId True uuid

웹후크를 고유하게 식별하는 ID

반환

Name 경로 형식 Description
enabled
 enabled boolean
event_types
 event_types array of string

웹후크를 발생시킬 이벤트 유형
extra_headers
 extra_headers array of object
아이디
 extra_headers.id uuid
이름
 extra_headers.name string

는 RFC 7230을 준수해야 합니다.
order
 extra_headers.order integer
value
 extra_headers.value string

는 RFC 7230을 준수해야 합니다.
웹후크
 extra_headers.webhook uuid
아이디
 id uuid
JSON
 json boolean
url
 url url

http/https를 포함하여 전체 URL이어야 합니다.

웹후크 공유 비밀 가져오기

작업 ID:
getWebhookSecret

웹후크 공유 비밀 가져오기

반환

Name 경로 형식 Description
create_date
 create_date date-time
secret
 secret b58

웹후크 공유 비밀 다시 생성

작업 ID:
regenerateWebhookSecret

웹후크 공유 비밀 다시 생성

반환

Name 경로 형식 Description
create_date
 create_date date-time
secret
 secret b58

웹후크 나열

작업 ID:
listWebhooks

BlueInk 계정의 모든 웹후크 나열

매개 변수

Name 키 필수 형식 Description
활성화됨
 enabled boolean

선택한 '사용' 상태와 일치하는 웹후크만 반환됩니다.

예: /webhooks/?enabled=true
이벤트 유형
 event_type string

선택한 event_type 또는 event_types 일치하는 웹후크만 반환됩니다.

예: /webhooks/?event_type=bundle_sent/webhooks/?event_type__in=bundle_error,bundle_cancelled

반환

Name 경로 형식 Description
array of object
enabled
 enabled boolean
event_types
 event_types array of string

웹후크를 발생시킬 이벤트 유형
extra_headers
 extra_headers array of object
아이디
 extra_headers.id uuid
이름
 extra_headers.name string

는 RFC 7230을 준수해야 합니다.
order
 extra_headers.order integer
value
 extra_headers.value string

는 RFC 7230을 준수해야 합니다.
웹후크
 extra_headers.webhook uuid
아이디
 id uuid
JSON
 json boolean
url
 url url

http/https를 포함하여 전체 URL이어야 합니다.

웹후크 만들기

작업 ID:
createWebhook

새 웹후크 만들기

매개 변수

Name 키 필수 형식 Description
enabled
 enabled boolean
event_types
 event_types array of string

웹후크를 발생시킬 이벤트 유형
아이디
 id uuid
이름
 name string

는 RFC 7230을 준수해야 합니다.
order
 order integer
value
 value string

는 RFC 7230을 준수해야 합니다.
웹후크
 webhook uuid
아이디
 id uuid
JSON
 json boolean
url
 url url

http/https를 포함하여 전체 URL이어야 합니다.

반환

Name 경로 형식 Description
enabled
 enabled boolean
event_types
 event_types array of string

웹후크를 발생시킬 이벤트 유형
extra_headers
 extra_headers array of object
아이디
 extra_headers.id uuid
이름
 extra_headers.name string

는 RFC 7230을 준수해야 합니다.
order
 extra_headers.order integer
value
 extra_headers.value string

는 RFC 7230을 준수해야 합니다.
웹후크
 extra_headers.webhook uuid
아이디
 id uuid
JSON
 json boolean
url
 url url

http/https를 포함하여 전체 URL이어야 합니다.

웹후크 부분 업데이트

작업 ID:
updateWebhookartial

웹후크를 새 데이터로 부분적으로 업데이트합니다.

매개 변수

Name 키 필수 형식 Description
웹후크 ID
 webhookId True uuid

웹후크를 고유하게 식별하는 ID
enabled
 enabled boolean
event_types
 event_types array of string

웹후크를 발생시킬 이벤트 유형
아이디
 id uuid
이름
 name string

는 RFC 7230을 준수해야 합니다.
order
 order integer
value
 value string

는 RFC 7230을 준수해야 합니다.
웹후크
 webhook uuid
아이디
 id uuid
JSON
 json boolean
url
 url url

http/https를 포함하여 전체 URL이어야 합니다.

반환

Name 경로 형식 Description
enabled
 enabled boolean
event_types
 event_types array of string

웹후크를 발생시킬 이벤트 유형
extra_headers
 extra_headers array of object
아이디
 extra_headers.id uuid
이름
 extra_headers.name string

는 RFC 7230을 준수해야 합니다.
order
 extra_headers.order integer
value
 extra_headers.value string

는 RFC 7230을 준수해야 합니다.
웹후크
 extra_headers.webhook uuid
아이디
 id uuid
JSON
 json boolean
url
 url url

http/https를 포함하여 전체 URL이어야 합니다.

웹후크 삭제

작업 ID:
deleteWebhook

ID로 웹후크 삭제

매개 변수

Name 키 필수 형식 Description
웹후크 ID
 webhookId True uuid

웹후크를 고유하게 식별하는 ID

웹후크 업데이트

작업 ID:
updateWebhook

웹후크를 새 데이터로 업데이트합니다. 이 요청에서 생략된 모든 구독은 삭제됩니다. 웹후크의 모든 데이터를 대체하지 않으려면 PATCH를 대신 사용하려고 할 것입니다.

매개 변수

Name 키 필수 형식 Description
웹후크 ID
 webhookId True uuid

웹후크를 고유하게 식별하는 ID
enabled
 enabled boolean
event_types
 event_types array of string

웹후크를 발생시킬 이벤트 유형
아이디
 id uuid
이름
 name string

는 RFC 7230을 준수해야 합니다.
order
 order integer
value
 value string

는 RFC 7230을 준수해야 합니다.
웹후크
 webhook uuid
아이디
 id uuid
JSON
 json boolean
url
 url url

http/https를 포함하여 전체 URL이어야 합니다.

반환

Name 경로 형식 Description
enabled
 enabled boolean
event_types
 event_types array of string

웹후크를 발생시킬 이벤트 유형
extra_headers
 extra_headers array of object
아이디
 extra_headers.id uuid
이름
 extra_headers.name string

는 RFC 7230을 준수해야 합니다.
order
 extra_headers.order integer
value
 extra_headers.value string

는 RFC 7230을 준수해야 합니다.
웹후크
 extra_headers.webhook uuid
아이디
 id uuid
JSON
 json boolean
url
 url url

http/https를 포함하여 전체 URL이어야 합니다.

인물 나열

작업 ID:
listPersons

계정의 인물 목록을 가져옵니다. 필요에 따라 검색 쿼리를 제공하여 목록을 필터링할 수 있습니다. 예를 들어 이름이 "John"인 모든 사람을 검색하려면 쿼리 search=John를 사용합니다.

매개 변수

Name 키 필수 형식 Description
쿼리 검색
 search string

검색 쿼리입니다.

반환

Name 경로 형식 Description
array of object
channels
 channels array of object
메일 주소
 channels.email email
아이디
 channels.id uuid
친절한
 channels.kind string

전자 메일의 경우 입니다. 전화의 경우 mp입니다.
phone
 channels.phone phone
아이디
 id uuid
is_user
 is_user boolean

True이면 이 사용자가 BlueInk 사용자와 연결됩니다.
metadata
 metadata object

이 사용자와 연결할 메타데이터입니다. SmartFill에서 메타데이터를 사용하여 문서를 자동으로 채울 수 있습니다. 자세한 내용은 SmartFill 설명서를 참조하세요.
이름
 name string

사용자의 이름입니다.

증명 정보 패킷 인증서 검색

작업 ID:
getPacketCOE

이 패킷에 대한 증거 인증서의 링크 및 체크섬 가져오기

매개 변수

Name 키 필수 형식 Description
패킷 슬러그
 packetId True string

패킷을 고유하게 식별하는 슬러그

패킷 업데이트

작업 ID:
updatePacket

새 전자 메일, 전화 번호, 이름 또는 인증 옵션으로 패킷(서명자)을 업데이트합니다.

업데이트된 패킷은 여전히 결과물이어야 합니다. 예를 들어 '전화' 값을 지정 deliver_via 하지만 원래 PacketRequest에 설정된 전화 번호가 없는 경우 이 요청에도 이 요청이 포함되어 phone 야 합니다. 그렇지 않으면 오류가 반환됩니다.

전자 메일 또는 SMS를 통해 배달되도록 원래 포함된 서명(즉, '포함'된 deliver_via)으로 구성된 패킷을 변경할 수 있습니다. 그러나 서명 알림이나 미리 알림은 자동으로 전송되지 않습니다. /packet/{packetId}/remind/를 호출하여 서명 알림 이메일(또는 SMS)을 보내야 합니다.

이 서명자가 개인과 연결된 경우 해당 사용자도 업데이트됩니다. 개인 이름이 변경되고(제공된 경우) 새 전자 메일 또는 전화 번호가 추가됩니다.

매개 변수

Name 키 필수 형식 Description
패킷 슬러그
 packetId True string

패킷을 고유하게 식별하는 슬러그
body
 body

포함된 서명 URL 만들기

작업 ID:
createPacketEmbedURL

포함된 서명에 사용할 수 있는 URL 만들기

매개 변수

Name 키 필수 형식 Description
패킷 슬러그
 packetId True string

패킷을 고유하게 식별하는 슬러그

반환

Name 경로 형식 Description
만료
 expires date-time

URL이 만료되는 시기를 나타내는 타임스탬프
url
 url string

포함된 서명에 사용할 수 있는 URL