藍墨水

Blueink 連接器可讓您將 Blueink 的電子簽章平台新增至自動化工作流程中。此連接器可讓您檢查套件組合狀態、建立新套件組合、存取簽署者資訊等。

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
邏輯應用程式	標準	所有 Logic Apps 區域，但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部（DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域： - 美國政府（GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）

連絡人
名稱	Blueink 支持
URL	https://help.blueink.com/en/
Email	support@blueink.com

連接器中繼資料
Publisher	藍墨
網站	https://blueink.com
隱私策略	https://blueink.com/privacy-policy/
類別	商業管理;生產力

借助這款多功能連接器，用戶可以利用各種 Power Automate 連接器的功能，將 Blueink 強大的電子簽名解決方案無縫集成到他們的工作流程中。這種整合使用戶能夠輕鬆自動建立和分發文件包。透過協調此連接器與其他連接器的和諧交互，您可以簡化文件管理流程、提高效率並確保為客戶和利害關係人提供無縫且高效的文件簽署體驗。無論是自動化合約審批、處理法律文件，還是在任何其他情況下管理文書工作，此連接器都提供了一個強大的工具來優化您的工作流程並提高生產力。

先決條件

若要使用此連接器，您需要來自 blueink.com 的已啟用 API 的帳戶。

如何取得認證

建立帳戶後，按一下頁面左側的 API 按鈕。在 「私有 API 金鑰」下，按 「新增 API 金鑰 」按鈕。為 API 金鑰提供標籤，然後按提交。複製 API 金鑰並將其儲存在某處，因為它不會再次顯示。

開始使用連接器

首次建立 Blueink 連線時，系統會提示您輸入 API 金鑰。您的 API 金鑰一律需要以 Token 開頭，後面接著空格，然後是您建立的 API 金鑰。輸入您的 API 金鑰應如下所示：權 杖 <API 金鑰>。

一個流行的動作是創建一個捆綁包。建立套件組合確實需要一組複雜的輸入。請查看我們的 API 文檔， https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle 了解 body 變量的外觀。下圖是套件建立主體的範例。

建立一個組合包

建立套件組合的方式有多種，您可以修改此 JSON 以符合您要建立的套件組合。請參閱 API，以瞭解修改此 JSON 的更多方式。此範本使用使用者在其帳戶中設定的先前建立的範本。

列出所有已完成的套件組合是另一個熱門端點。新增列出服務包動作，然後將狀態按鈕變更為 co ，以取得已完成的服務服務。您可以使用此端點，隨時掌握所有最新已完成的服務包。

列表組合

已知問題與限制

套件建立端點需要內文 JSON

常見錯誤和補救措施

如果您收到有關請求未成功的錯誤，並出現無效的權杖錯誤，請確保您不只是貼上 API 金鑰，並包含前面的權杖字串，後面接著一個空格，然後是您的 API 金鑰。

如果您在建立套件時收到有關無效輸入的錯誤，請確保它是發送到 Blueink 的有效 JSON。

FAQ

1. 什麼是 Blueink？

Blueink 是一種先進的電子簽名解決方案，可簡化文檔簽名流程，使安全發送、簽名和管理電子文檔變得容易。

2. 什麼是 Microsoft Connector for Blueink？

Microsoft Connector for Blueink 是一款允許用戶將 Blueink 的電子簽名解決方案與 Microsoft Power Automate 無縫集成的工具，從而實現自動化和增強的文件管理。

3. Microsoft Connector for Blueink 如何運作？

連接器可讓您將 Blueink 與其他 Power Automate 連接器結合，以建立自動化工作流程。您可以自動建立和分發文件包，從而增強您的文件管理流程。

4. Microsoft Connector for Blueink 有哪些用例？

常見用例包括自動化合約審批、管理法律文件、簡化文書工作流程以及確保客戶和利害關係人獲得順暢且有效率的文件簽署體驗。

5. 我可以將 Microsoft Connector for Blueink 與其他 Microsoft 產品搭配使用嗎？

是的，該連接器旨在與各種 Microsoft 產品和服務無縫協作，允許您將 Blueink 電子簽名整合到以 Microsoft 為中心的工作流程中。

6. Microsoft Connector for Blueink 易於設定和使用嗎？

是的，它用戶友好且設計簡單。您可以配置和自訂工作流程，以符合您特定的文件管理需求。

7. 使用 Microsoft Connector for Blueink 是否有任何費用？

定價可能會根據您的使用情況和授權協議而有所不同。最好諮詢 Blueink 或 Microsoft 以了解具體的定價詳細資訊。

8. 我可以獲得 Microsoft Connector for Blueink 任何技術問題的支援嗎？

是的，Blueink 和 Microsoft 通常會提供支援資源和文檔，以協助解決有關連接器使用的任何技術問題或問題。

9. Microsoft Connector for Blueink 是否與 Windows 和基於雲端的 Microsoft 服務相容？

是的，該連接器旨在與本地和基於雲端的 Microsoft 服務配合使用，為您的整合選項提供靈活性。

10. 在哪裡可以找到有關 Microsoft Connector for Blueink 的更多資訊？

如需其他資訊，包括設定指南和文件，您可以造訪 Blueink 網站或瀏覽與此連接器相關的 Microsoft Power Automate 文件。

正在建立連線

連接器支援下列驗證類型：


預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
Blueink API 金鑰	securestring	您的 Blueink API 金鑰。這可以在 Blueink 的 API 選項卡下創建。正確的格式是“令牌 XXXXXX”，其中 XXXXXX 是您的 API 密鑰	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

列出 Webhook	列出您 BlueInk 帳戶中的所有 Webhook
列出 WebhookEvents	列出您 BlueInk 帳戶中的所有 Webhook 事件
列出 WebhookEvents	列出您 BlueInk 帳戶中的所有 WebhookDeliveryies
列出 WebhookExtraHeaders	列出您 BlueInk 帳戶中的所有 WebhookExtraHeaders
列出人員	獲取您帳戶中的人員列表。您可以選擇性地透過提供搜尋查詢來篩選清單。例如，若要搜尋名稱為「John」的所有人員，您可以使用查詢 `search=John`。
列出捆綁事件	取得與套件組合相關聯的事件清單
列出捆綁包	傳回您帳戶中捆綁包的分頁清單，依建立日期（從最近到最近）排序。分頁可以透過分頁參數進行控制（請參閱概述->分頁）。查詢字串過濾器參數可以組合，例如 `/bundles/?search=Gibbons&status__in=se,co&tag=needs-attention`. 組合篩選器時，只會傳回符合所有篩選器的套件組合。
列出文件範本	列出所有文件範本
刪除 Webhook	依識別碼刪除 Webhook
刪除 WebhookExtraHeader	刪除 WebhookExtraHeader
刪除人員	刪除人員。這也會刪除任何關聯的 BlueInk 使用者。
取得 Webhook 共用密碼	取得 Webhook 共用密碼
取消捆綁包	取消 Bundle Slug 指定的 Bundle
將標籤新增至套件組合	將其他標籤新增至套件組合。不會移除套件組合上的現有標籤。此呼叫的結果是 Bundle.tags 是先前標籤集與新標籤集的聯集。重複的標籤會被忽略。
建立 Webhook	建立新的 Webhook
建立 WebhookExtraHeader	建立新的 Webhook 標頭
建立人員	建立新人員。人員可以與 BlueInk 使用者相關聯，也可以是獨立人員。如果您想要建立與 BlueInk 使用者相關聯的人員，您必須提供欄位 `user_id` 。如果您想要建立獨立人員，則必須提供 `name` 欄位。
建立內嵌簽署 URL	建立可用於內嵌簽署的 URL
建立套件組合	建立並傳送套件組合以供簽署
從套件組合中移除標籤	從套件組合中移除標籤。如果請求中的標籤不存在於 Bundle 上，則會忽略它。
擷取 Webhook	依識別碼取得 Webhook
擷取 WebhookExtraHeader	擷取 WebhookExtraHeader 的詳細資料
擷取人員	通過 ID 獲取一個人
擷取套件組合	透過 slug 擷取套件組合
擷取套件組合檔案	取得完整捆綁包的可下載檔案
擷取套件組合資料	將資料輸入到已完成套件組合的欄位中
擷取文件範本	擷取文件範本
擷取資料包證據憑證	獲取此資料包的證據證書的連結和校驗和
更新 Webhook	使用新資料更新 Webhook。請注意，此請求中省略的任何訂閱都將被刪除。如果您不想取代 Webhook 上的所有資料，您可能想要改用 PATCH。
更新 WebhookExtraHeader	使用新資料更新 WebhookExtraHeader
更新人員	使用新資料更新人員。請注意，此請求中省略的任何聯絡管道都將被刪除。如果您不想取代人員上的所有資料，您可能想要改用 PATCH。
更新封包	使用新的電子郵件、電話號碼、名稱或驗證選項更新封包（又稱簽署者）更新後的資料包仍必須可傳遞。例如，如果您指定 `deliver_via` 'phone' 值，但原始 PacketRequest 中未設定電話號碼，則此要求也必須包含 a `phone` ，否則會傳回錯誤。您可以將最初設定為內嵌簽署的封包（即deliver_via「嵌入」）變更為透過電子郵件或簡訊傳遞。但是，不會自動發送任何簽名通知或提醒。您必須呼叫 /packet/{packetId}/remind/ 來傳送簽署通知電子郵件（或簡訊）。如果此簽署者與人員相關聯，則該人員也會更新 - 人員名稱將變更（如果提供），並新增任何新的電子郵件或電話號碼。
發送提醒	傳送提醒電子郵件或簡訊給簽署者。每小時只能發送一次提醒。提醒將透過遞送方式（電郵或短訊）及先前為本郵包指定的電郵地址（或電話號碼）發送。
部分更新 Webhook	使用新資料部分更新 Webhook。
部分更新 WebhookExtraHeader	使用新資料部分更新 WebhookExtraHeader。
部分更新人員	使用新資料部分更新人員。若要將新的電子郵件或電話新增至人員，請在「channels」陣列中包含一個 ContactChannel，而不使用 'id'。若要更新與人員相關聯的現有 ContactChannel，請包含 'id'。現有的 ContactChannel 將使用新的電子郵件或電話進行更新。這將更新與傳送至該電子郵件（或電話）的人員相關聯的任何即時套件組合。如果 ContactChannel 不包含 'id'，但電子郵件（或電話）符合現有的 ContactChannel，則不會變更該 ContactChannel。
重新產生 Webhook 共用密碼	重新產生 Webhook 共用密碼

列出 Webhook

作業識別碼：: listWebhooks

列出您 BlueInk 帳戶中的所有 Webhook

參數

名稱機碼必要類型 Description

名稱	機碼	必要	類型	Description
已啟用	enabled		boolean	只會傳回符合所選「已啟用」狀態的 Webhook。例如 `/webhooks/?enabled=true`
事件類型	event_type		string	只會傳回符合所選event_type或event_types的 Webhook。例如， `/webhooks/?event_type=bundle_sent` 例如 `/webhooks/?event_type__in=bundle_error,bundle_cancelled`

已啟用

enabled

boolean

只會傳回符合所選「已啟用」狀態的 Webhook。

例如 /webhooks/?enabled=true

事件類型

event_type

string

只會傳回符合所選event_type或event_types的 Webhook。

例如， /webhooks/?event_type=bundle_sent 例如 /webhooks/?event_type__in=bundle_error,bundle_cancelled

傳回

名稱	路徑	類型	Description
		array of object
enabled	enabled	boolean
event_types	event_types	array of string	將觸發 Webhook 的事件類型
extra_headers	extra_headers	array of object
識別碼	extra_headers.id	uuid
名稱	extra_headers.name	string	必須遵守 RFC 7230
順序	extra_headers.order	integer
value	extra_headers.value	string	必須遵守 RFC 7230
Webhook	extra_headers.webhook	uuid
識別碼	id	uuid
JSON（JavaScript物件表示法）	json	boolean
url	url	url	應該是完整的URL，包括http/https

列出 WebhookEvents

作業識別碼：: listWebhookEvents

列出您 BlueInk 帳戶中的所有 Webhook 事件

參數

名稱	機碼	類型	Description
Webhook ID識別碼	webhook	uuid	只會傳回符合所選 Webhook ID 的 WebhookEvents。例如 `/webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346`
事件類型	event_type	string	只會傳回 WebhookEvents 的 WebhookEvents ，其 Webhook 符合所選event_type或event_types。例如， `/webhooks/events/?event_type=bundle_sent` 例如 `/webhooks/events/?event_type__in=bundle_error,bundle_cancelled`
地位	status	integer	只會傳回符合所選狀態的 WebhookEvents。例如， `/webhooks/events/?status=1` 例如 `/webhooks/events/?status__in=0,1,2`
成功結果	success	boolean	只會傳回符合所選成功狀態的WebhookEvents。例如 `/webhooks/events/?success=true`
日期範圍	date	date-time	只會傳回日期範圍之間發生的WebhookEvents。注意：日期以 YYYY-MM-DD 格式表示。例如 `/webhooks/events/?date_after=2022-10-01&date_before=2022-10-31`

傳回

名稱	路徑	類型	Description
		array of object
創建	created	date-time
送貨	deliveries	array of object
訊息	deliveries.message	string	說明任何問題的訊息
PK	deliveries.pk	uuid
狀態	deliveries.status	integer	回應的狀態訊息，如果沒有狀態，則為 0
時間戳記	deliveries.timestamp	date-time	傳遞嘗試發生的時間（嘗試的開始，而不是失敗的時間，例如逾時）
event_type	event_type	string
承載	payload	string	交付時發送的有效載荷;簡短的
PK	pk	uuid
狀態	status	integer	來自 Webhook 端點的最後一個回應的狀態碼。 0 表示未收到回應
勝	success	boolean
Webhook	webhook	uuid	UUID 識別事件所屬的 Webhook

列出 WebhookEvents

作業識別碼：: listWebhookDeliveries

列出您 BlueInk 帳戶中的所有 WebhookDeliveryies

參數

名稱	機碼	類型	Description
Webhook ID識別碼	webhook	uuid	只會傳回符合所選Webhook識別碼的WebhookDeliveryies。例如 `/webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346`
Webhook 事件識別碼	webhook_event	uuid	只會傳回符合所選webhook_event識別碼的WebhookDeliveryies。例如 `/webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346`
事件類型	event_type	string	只有 WebhookDeliverys 的 Webhook 符合所選event_type或event_types才會傳回。例如， `/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	只會傳回日期範圍之間發生的WebhookDeliveryies。注意：日期以 YYYY-MM-DD 格式表示。例如 `/webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31`

傳回

名稱	路徑	類型	Description
		array of object
創建	created	date-time
送貨	deliveries	array of object
訊息	deliveries.message	string	說明任何問題的訊息
PK	deliveries.pk	uuid
狀態	deliveries.status	integer	回應的狀態訊息，如果沒有狀態，則為 0
時間戳記	deliveries.timestamp	date-time	傳遞嘗試發生的時間（嘗試的開始，而不是失敗的時間，例如逾時）
event_type	event_type	string
承載	payload	string	交付時發送的有效載荷;簡短的
PK	pk	uuid
狀態	status	integer	來自 Webhook 端點的最後一個回應的狀態碼。 0 表示未收到回應
勝	success	boolean
Webhook	webhook	uuid	UUID 識別事件所屬的 Webhook

列出 WebhookExtraHeaders

作業識別碼：: listWebhookExtraHeaders

列出您 BlueInk 帳戶中的所有 WebhookExtraHeaders

參數

名稱機碼必要類型 Description

名稱	機碼	必要	類型	Description
Webhook ID識別碼	webhook		uuid	只會傳回符合所選 Webhook ID 的 WebhookExtraHeaders。例如 `/webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346`
事件類型	event_type		string	只會傳回 WebhookExtraHeaders 的 WebhookExtraHeaders ，其 Webhook 符合所選event_type或event_types。例如， `/webhooks/headers/?event_type=bundle_sent` 例如 `/webhooks/headers/?event_type__in=bundle_error,bundle_cancelled`

Webhook ID識別碼

webhook

uuid

只會傳回符合所選 Webhook ID 的 WebhookExtraHeaders。

例如 /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346

事件類型

event_type

string

只會傳回 WebhookExtraHeaders 的 WebhookExtraHeaders ，其 Webhook 符合所選event_type或event_types。

例如， /webhooks/headers/?event_type=bundle_sent 例如 /webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

傳回

名稱	路徑	類型	Description
		array of object
識別碼	id	uuid
名稱	name	string	必須遵守 RFC 7230
順序	order	integer
value	value	string	必須遵守 RFC 7230
Webhook	webhook	uuid

列出人員

作業識別碼：: listPersons

獲取您帳戶中的人員列表。您可以選擇性地透過提供搜尋查詢來篩選清單。例如，若要搜尋名稱為「John」的所有人員，您可以使用查詢 search=John。

參數

名稱	機碼	必要	類型	Description
搜尋查詢	search		string	搜尋查詢。

傳回

名稱	路徑	類型	Description
		array of object
通道	channels	array of object
電子郵件	channels.email	email
識別碼	channels.id	uuid
類型	channels.kind	string	em 用於電子郵件。 mp 代表電話。
phone	channels.phone	phone
識別碼	id	uuid
is_user	is_user	boolean	如果此人員與 BlueInk 使用者相關聯，則為 True
中繼資料	metadata	object	與此人相關聯的中繼資料。中繼資料可用於 SmartFill 來自動填入文件。如需詳細資訊，請參閱 SmartFill 文件。
名稱	name	string	人員姓名

列出捆綁事件

作業識別碼：: listBundleEvents

取得與套件組合相關聯的事件清單

參數

名稱	機碼	必要	類型	Description
捆綁彈頭	bundleSlug	True	string	唯一識別 Bundle 的 slug

傳回

名稱	路徑	類型	Description
		array of object
描述	description	string	對事件的簡要描述
類型	kind	string	事件類型為 2 個字元代碼
packet_id	packet_id	uuid	封包的 UUID。只有在事件與特定封包相關聯時才會出現。
時間戳記	timestamp	date-time	事件發生的時間

列出捆綁包

作業識別碼：: listBundles

傳回您帳戶中捆綁包的分頁清單，依建立日期（從最近到最近）排序。分頁可以透過分頁參數進行控制（請參閱概述->分頁）。查詢字串過濾器參數可以組合，例如 /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. 組合篩選器時，只會傳回符合所有篩選器的套件組合。

參數

名稱	機碼	類型	Description
搜尋查詢	search	string	搜尋查詢。只會傳回符合搜尋的套件組合。會搜尋「套件組合」中的下列資料：捆綁彈頭捆綁標籤捆綁custom_key 簽署者名稱簽署者電子郵件簽署者電話例如 `/bundles/?search=foobar@example.com`
捆綁狀態	status	string	將套件組合限制為具有指定狀態的套件組合。 dr：草稿 - 捆綁包尚未發送 se：已傳送 - 套件組合已傳送，但尚未由任何簽署者啟動 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”排序，即捆綁包創建日期從最晚到最晚。

傳回

名稱	路徑	類型	Description
		array of

列出文件範本

作業識別碼：: listTemplates

列出所有文件範本

傳回

名稱	路徑	類型	Description
fields	fields	array of	放置在文件上的欄位陣列。請注意，DocumentTemplate 欄位與 DocumentRequest 欄位略有不同，具有 `default_value` and `editor_roles` 而不是 `initial_valueeditors`and 。
file_url	file_url	string	作為此範本基礎的原始檔案的 URL
is_shared	is_shared	boolean	如果文件範本是共用的，則為 true。否則為假
名稱	name	string	文件的名稱。預設為上傳時的檔案名稱或文件，但可以設定為易記人為的名稱。
角色	roles	array of object
Key	roles.key	string	此文件的唯一字串，用於識別此角色
標籤	roles.label	string	這個角色的人性化標籤

刪除 Webhook

作業識別碼：: deleteWebhook

依識別碼刪除 Webhook

參數

名稱	機碼	必要	類型	Description
Webhook ID識別碼	webhookId	True	uuid	唯一識別 Webhook 的 ID

刪除 WebhookExtraHeader

作業識別碼：: deleteWebhookExtraHeader

刪除 WebhookExtraHeader

參數

名稱	機碼	必要	類型	Description
WebhookExtra標頭識別碼	webhookExtraHeaderId	True	uuid	唯一識別 WebhookExtraHeader 的識別碼

刪除人員

作業識別碼：: deletePerson

刪除人員。這也會刪除任何關聯的 BlueInk 使用者。

參數

名稱	機碼	必要	類型	Description
人員 ID	personId	True	uuid	唯一識別人員的 ID

取得 Webhook 共用密碼

作業識別碼：: getWebhookSecret

取得 Webhook 共用密碼

傳回

名稱	路徑	類型	Description
create_date	create_date	date-time
密碼	secret	b58

取消捆綁包

作業識別碼：: cancelBundle

取消 Bundle Slug 指定的 Bundle

參數

名稱	機碼	必要	類型	Description
捆綁彈頭	bundleSlug	True	string	唯一識別 Bundle 的 slug

將標籤新增至套件組合

作業識別碼：: addBundleTags

將其他標籤新增至套件組合。不會移除套件組合上的現有標籤。此呼叫的結果是 Bundle.tags 是先前標籤集與新標籤集的聯集。重複的標籤會被忽略。

參數

名稱	機碼	必要	類型	Description
捆綁彈頭	bundleSlug	True	string	唯一識別 Bundle 的 slug
tags	tags		array of string	標記的陣列

建立 Webhook

作業識別碼：: createWebhook

建立新的 Webhook

參數

名稱	機碼	類型	Description
enabled	enabled	boolean
event_types	event_types	array of string	將觸發 Webhook 的事件類型
識別碼	id	uuid
名稱	name	string	必須遵守 RFC 7230
順序	order	integer
value	value	string	必須遵守 RFC 7230
Webhook	webhook	uuid
識別碼	id	uuid
JSON（JavaScript物件表示法）	json	boolean
url	url	url	應該是完整的URL，包括http/https

傳回

名稱	路徑	類型	Description
enabled	enabled	boolean
event_types	event_types	array of string	將觸發 Webhook 的事件類型
extra_headers	extra_headers	array of object
識別碼	extra_headers.id	uuid
名稱	extra_headers.name	string	必須遵守 RFC 7230
順序	extra_headers.order	integer
value	extra_headers.value	string	必須遵守 RFC 7230
Webhook	extra_headers.webhook	uuid
識別碼	id	uuid
JSON（JavaScript物件表示法）	json	boolean
url	url	url	應該是完整的URL，包括http/https

建立 WebhookExtraHeader

作業識別碼：: createWebhookExtraHeader

建立新的 Webhook 標頭

參數

名稱	機碼	類型	Description
識別碼	id	uuid
名稱	name	string	必須遵守 RFC 7230
順序	order	integer
value	value	string	必須遵守 RFC 7230
Webhook	webhook	uuid

傳回

名稱	路徑	類型	Description
識別碼	id	uuid
名稱	name	string	必須遵守 RFC 7230
順序	order	integer
value	value	string	必須遵守 RFC 7230
Webhook	webhook	uuid

建立人員

作業識別碼：: createPerson

建立新人員。人員可以與 BlueInk 使用者相關聯，也可以是獨立人員。如果您想要建立與 BlueInk 使用者相關聯的人員，您必須提供欄位 user_id 。如果您想要建立獨立人員，則必須提供 name 欄位。

參數

名稱	機碼	類型	Description
電子郵件	email	email
識別碼	id	uuid
類型	kind	string	em 用於電子郵件。 mp 代表電話。
phone	phone	phone
識別碼	id	uuid
is_user	is_user	boolean	如果此人員與 BlueInk 使用者相關聯，則為 True
中繼資料	metadata	object	與此人相關聯的中繼資料。中繼資料可用於 SmartFill 來自動填入文件。如需詳細資訊，請參閱 SmartFill 文件。
名稱	name	string	人員姓名

傳回

名稱	路徑	類型	Description
通道	channels	array of object
電子郵件	channels.email	email
識別碼	channels.id	uuid
類型	channels.kind	string	em 用於電子郵件。 mp 代表電話。
phone	channels.phone	phone
識別碼	id	uuid
is_user	is_user	boolean	如果此人員與 BlueInk 使用者相關聯，則為 True
中繼資料	metadata	object	與此人相關聯的中繼資料。中繼資料可用於 SmartFill 來自動填入文件。如需詳細資訊，請參閱 SmartFill 文件。
名稱	name	string	人員姓名

建立內嵌簽署 URL

作業識別碼：: createPacketEmbedURL

建立可用於內嵌簽署的 URL

參數

名稱	機碼	必要	類型	Description
封包 Slug	packetId	True	string	唯一識別封包的 slug

傳回

名稱	路徑	類型	Description
過期	expires	date-time	指出網址何時到期的時間戳記
url	url	string	可用於內嵌簽署的URL

建立套件組合

作業識別碼：: createBundle

建立並傳送套件組合以供簽署

參數

名稱	機碼	必要	類型	Description
body	body			定義要建立的套件組合的 JSON 內文

從套件組合中移除標籤

作業識別碼：: removeBundleTags

從套件組合中移除標籤。如果請求中的標籤不存在於 Bundle 上，則會忽略它。

參數

名稱	機碼	必要	類型	Description
捆綁彈頭	bundleSlug	True	string	唯一識別 Bundle 的 slug
tags	tags		array of string	標記的陣列

擷取 Webhook

作業識別碼：: getWebhook

依識別碼取得 Webhook

參數

名稱	機碼	必要	類型	Description
Webhook ID識別碼	webhookId	True	uuid	唯一識別 Webhook 的 ID

傳回

名稱	路徑	類型	Description
enabled	enabled	boolean
event_types	event_types	array of string	將觸發 Webhook 的事件類型
extra_headers	extra_headers	array of object
識別碼	extra_headers.id	uuid
名稱	extra_headers.name	string	必須遵守 RFC 7230
順序	extra_headers.order	integer
value	extra_headers.value	string	必須遵守 RFC 7230
Webhook	extra_headers.webhook	uuid
識別碼	id	uuid
JSON（JavaScript物件表示法）	json	boolean
url	url	url	應該是完整的URL，包括http/https

擷取 WebhookExtraHeader

作業識別碼：: getWebhookExtraHeader

擷取 WebhookExtraHeader 的詳細資料

參數

名稱	機碼	必要	類型	Description
WebhookExtra標頭識別碼	webhookExtraHeaderId	True	uuid	唯一識別 WebhookExtraHeader 的識別碼

傳回

名稱	路徑	類型	Description
識別碼	id	uuid
名稱	name	string	必須遵守 RFC 7230
順序	order	integer
value	value	string	必須遵守 RFC 7230
Webhook	webhook	uuid

擷取人員

作業識別碼：: getPerson

通過 ID 獲取一個人

參數

名稱	機碼	必要	類型	Description
人員 ID	personId	True	uuid	唯一識別人員的 ID

傳回

名稱	路徑	類型	Description
通道	channels	array of object
電子郵件	channels.email	email
識別碼	channels.id	uuid
類型	channels.kind	string	em 用於電子郵件。 mp 代表電話。
phone	channels.phone	phone
識別碼	id	uuid
is_user	is_user	boolean	如果此人員與 BlueInk 使用者相關聯，則為 True
中繼資料	metadata	object	與此人相關聯的中繼資料。中繼資料可用於 SmartFill 來自動填入文件。如需詳細資訊，請參閱 SmartFill 文件。
名稱	name	string	人員姓名

擷取套件組合

作業識別碼：: retrieveBundle

透過 slug 擷取套件組合

參數

名稱	機碼	必要	類型	Description
捆綁彈頭	bundleSlug	True	string	唯一識別 Bundle 的 slug

擷取套件組合檔案

作業識別碼：: getBundleFiles

取得完整捆綁包的可下載檔案

參數

名稱	機碼	必要	類型	Description
捆綁彈頭	bundleSlug	True	string	唯一識別 Bundle 的 slug

傳回

名稱	路徑	類型	Description
		array of object
過期	expires	string	鏈結到期的時間，以 ISO 8601 格式的時間表示
file_url	file_url	string	可從中下載檔案的 URL

擷取套件組合資料

作業識別碼：: getBundleData

將資料輸入到已完成套件組合的欄位中

參數

名稱	機碼	必要	類型	Description
捆綁彈頭	bundleSlug	True	string	唯一識別 Bundle 的 slug

傳回

名稱	路徑	類型	Description
		array of object
attachments	attachments	array of object	附件欄位的檔案附件陣列，或 Null
分機	attachments.ext	string	檔案副檔名
is_image	attachments.is_image	boolean	如果此附件檔是影像，則為 true
名稱	attachments.name	string	附件的檔案名稱
數字	attachments.num	integer	新增檔案的順序，如果我們對單一附件欄位有多次上傳（例如，使用網路攝影機拍攝的文件每一頁的相片）
size	attachments.size	integer	檔案大小（以位元組為單位）
url	attachments.url	url	可暫時用於下載附件檔的 URL
doc_key	doc_key	string	在Bundle中唯一識別此文檔的索引鍵（來自原始BundleRequest）
field_key	field_key	string	唯一識別 Document 中欄位的索引鍵（如 BundleRequest 中 DocumentRequest 的原始 DocumentRequestField 中所指定，或在 DocumentTemplate 上設定）
filled_by	filled_by	string	輸入此欄位值之簽署者的封包金鑰。如果欄位值是未由簽署者編輯的「initial_value」，則值為「初始」。如果欄位值是 DocumentTemplate 上設定的預設值，則填入器為「預設」。
類型	kind	string	那種領域
標籤	label	string	欄位的標籤（可能是空白）
packet_id	packet_id		輸入此欄位值的簽署者的封包 ID，如果簽署者未填寫欄位值，則為空值（即，它是initial_value值或既定值）。
value	value		欄位的值。

擷取文件範本

作業識別碼：: retrieveTemplate

擷取文件範本

參數

名稱	機碼	必要	類型	Description
範本識別碼	templateId	True	uuid	唯一識別範本的識別碼

傳回

名稱	路徑	類型	Description
fields	fields	array of	放置在文件上的欄位陣列。請注意，DocumentTemplate 欄位與 DocumentRequest 欄位略有不同，具有 `default_value` and `editor_roles` 而不是 `initial_valueeditors`and 。
file_url	file_url	string	作為此範本基礎的原始檔案的 URL
is_shared	is_shared	boolean	如果文件範本是共用的，則為 true。否則為假
名稱	name	string	文件的名稱。預設為上傳時的檔案名稱或文件，但可以設定為易記人為的名稱。
角色	roles	array of object
Key	roles.key	string	此文件的唯一字串，用於識別此角色
標籤	roles.label	string	這個角色的人性化標籤

擷取資料包證據憑證

作業識別碼：: getPacketCOE

獲取此資料包的證據證書的連結和校驗和

參數

名稱	機碼	必要	類型	Description
封包 Slug	packetId	True	string	唯一識別封包的 slug

更新 Webhook

作業識別碼：: updateWebhook

使用新資料更新 Webhook。請注意，此請求中省略的任何訂閱都將被刪除。如果您不想取代 Webhook 上的所有資料，您可能想要改用 PATCH。

參數

名稱	機碼	必要	類型	Description
Webhook ID識別碼	webhookId	True	uuid	唯一識別 Webhook 的 ID
enabled	enabled		boolean
event_types	event_types		array of string	將觸發 Webhook 的事件類型
識別碼	id		uuid
名稱	name		string	必須遵守 RFC 7230
順序	order		integer
value	value		string	必須遵守 RFC 7230
Webhook	webhook		uuid
識別碼	id		uuid
JSON（JavaScript物件表示法）	json		boolean
url	url		url	應該是完整的URL，包括http/https

傳回

名稱	路徑	類型	Description
enabled	enabled	boolean
event_types	event_types	array of string	將觸發 Webhook 的事件類型
extra_headers	extra_headers	array of object
識別碼	extra_headers.id	uuid
名稱	extra_headers.name	string	必須遵守 RFC 7230
順序	extra_headers.order	integer
value	extra_headers.value	string	必須遵守 RFC 7230
Webhook	extra_headers.webhook	uuid
識別碼	id	uuid
JSON（JavaScript物件表示法）	json	boolean
url	url	url	應該是完整的URL，包括http/https

更新 WebhookExtraHeader

作業識別碼：: updateWebhookExtraHeader

使用新資料更新 WebhookExtraHeader

參數

名稱	機碼	必要	類型	Description
WebhookExtra標頭識別碼	webhookExtraHeaderId	True	uuid	唯一識別 WebhookExtraHeader 的識別碼
識別碼	id		uuid
名稱	name		string	必須遵守 RFC 7230
順序	order		integer
value	value		string	必須遵守 RFC 7230
Webhook	webhook		uuid

傳回

名稱	路徑	類型	Description
識別碼	id	uuid
名稱	name	string	必須遵守 RFC 7230
順序	order	integer
value	value	string	必須遵守 RFC 7230
Webhook	webhook	uuid

更新人員

作業識別碼：: updatePerson

使用新資料更新人員。請注意，此請求中省略的任何聯絡管道都將被刪除。如果您不想取代人員上的所有資料，您可能想要改用 PATCH。

參數

名稱	機碼	必要	類型	Description
人員 ID	personId	True	uuid	唯一識別人員的 ID
電子郵件	email		email
識別碼	id		uuid
類型	kind		string	em 用於電子郵件。 mp 代表電話。
phone	phone		phone
識別碼	id		uuid
is_user	is_user		boolean	如果此人員與 BlueInk 使用者相關聯，則為 True
中繼資料	metadata		object	與此人相關聯的中繼資料。中繼資料可用於 SmartFill 來自動填入文件。如需詳細資訊，請參閱 SmartFill 文件。
名稱	name		string	人員姓名

傳回

名稱	路徑	類型	Description
通道	channels	array of object
電子郵件	channels.email	email
識別碼	channels.id	uuid
類型	channels.kind	string	em 用於電子郵件。 mp 代表電話。
phone	channels.phone	phone
識別碼	id	uuid
is_user	is_user	boolean	如果此人員與 BlueInk 使用者相關聯，則為 True
中繼資料	metadata	object	與此人相關聯的中繼資料。中繼資料可用於 SmartFill 來自動填入文件。如需詳細資訊，請參閱 SmartFill 文件。
名稱	name	string	人員姓名

更新封包

作業識別碼：: updatePacket

使用新的電子郵件、電話號碼、名稱或驗證選項更新封包（又稱簽署者）

更新後的資料包仍必須可傳遞。例如，如果您指定 deliver_via 'phone' 值，但原始 PacketRequest 中未設定電話號碼，則此要求也必須包含 a phone ，否則會傳回錯誤。

您可以將最初設定為內嵌簽署的封包（即deliver_via「嵌入」）變更為透過電子郵件或簡訊傳遞。但是，不會自動發送任何簽名通知或提醒。您必須呼叫 /packet/{packetId}/remind/ 來傳送簽署通知電子郵件（或簡訊）。

如果此簽署者與人員相關聯，則該人員也會更新 - 人員名稱將變更（如果提供），並新增任何新的電子郵件或電話號碼。

參數

名稱	機碼	必要	類型	Description
封包 Slug	packetId	True	string	唯一識別封包的 slug
body	body

發送提醒

作業識別碼：: sendPacketReminder

傳送提醒電子郵件或簡訊給簽署者。每小時只能發送一次提醒。提醒將透過遞送方式（電郵或短訊）及先前為本郵包指定的電郵地址（或電話號碼）發送。

參數

名稱	機碼	必要	類型	Description
封包 Slug	packetId	True	string	唯一識別封包的 slug

部分更新 Webhook

作業識別碼：: updateWebhookartial

使用新資料部分更新 Webhook。

參數

名稱	機碼	必要	類型	Description
Webhook ID識別碼	webhookId	True	uuid	唯一識別 Webhook 的 ID
enabled	enabled		boolean
event_types	event_types		array of string	將觸發 Webhook 的事件類型
識別碼	id		uuid
名稱	name		string	必須遵守 RFC 7230
順序	order		integer
value	value		string	必須遵守 RFC 7230
Webhook	webhook		uuid
識別碼	id		uuid
JSON（JavaScript物件表示法）	json		boolean
url	url		url	應該是完整的URL，包括http/https

傳回

名稱	路徑	類型	Description
enabled	enabled	boolean
event_types	event_types	array of string	將觸發 Webhook 的事件類型
extra_headers	extra_headers	array of object
識別碼	extra_headers.id	uuid
名稱	extra_headers.name	string	必須遵守 RFC 7230
順序	extra_headers.order	integer
value	extra_headers.value	string	必須遵守 RFC 7230
Webhook	extra_headers.webhook	uuid
識別碼	id	uuid
JSON（JavaScript物件表示法）	json	boolean
url	url	url	應該是完整的URL，包括http/https

部分更新 WebhookExtraHeader

作業識別碼：: updateWebhookExtraHeaderPartial

使用新資料部分更新 WebhookExtraHeader。

參數

名稱	機碼	必要	類型	Description
WebhookExtra標頭識別碼	webhookExtraHeaderId	True	uuid	唯一識別 WebhookExtraHeader 的識別碼
識別碼	id		uuid
名稱	name		string	必須遵守 RFC 7230
順序	order		integer
value	value		string	必須遵守 RFC 7230
Webhook	webhook		uuid

傳回

名稱	路徑	類型	Description
識別碼	id	uuid
名稱	name	string	必須遵守 RFC 7230
順序	order	integer
value	value	string	必須遵守 RFC 7230
Webhook	webhook	uuid

部分更新人員

作業識別碼：: updatePersonPartial

使用新資料部分更新人員。

若要將新的電子郵件或電話新增至人員，請在「channels」陣列中包含一個 ContactChannel，而不使用 'id'。

若要更新與人員相關聯的現有 ContactChannel，請包含 'id'。現有的 ContactChannel 將使用新的電子郵件或電話進行更新。這將更新與傳送至該電子郵件（或電話）的人員相關聯的任何即時套件組合。

如果 ContactChannel 不包含 'id'，但電子郵件（或電話）符合現有的 ContactChannel，則不會變更該 ContactChannel。

參數

名稱	機碼	必要	類型	Description
人員 ID	personId	True	uuid	唯一識別人員的 ID
電子郵件	email		email
識別碼	id		uuid
類型	kind		string	em 用於電子郵件。 mp 代表電話。
phone	phone		phone
識別碼	id		uuid
is_user	is_user		boolean	如果此人員與 BlueInk 使用者相關聯，則為 True
中繼資料	metadata		object	與此人相關聯的中繼資料。中繼資料可用於 SmartFill 來自動填入文件。如需詳細資訊，請參閱 SmartFill 文件。
名稱	name		string	人員姓名

傳回

名稱	路徑	類型	Description
通道	channels	array of object
電子郵件	channels.email	email
識別碼	channels.id	uuid
類型	channels.kind	string	em 用於電子郵件。 mp 代表電話。
phone	channels.phone	phone
識別碼	id	uuid
is_user	is_user	boolean	如果此人員與 BlueInk 使用者相關聯，則為 True
中繼資料	metadata	object	與此人相關聯的中繼資料。中繼資料可用於 SmartFill 來自動填入文件。如需詳細資訊，請參閱 SmartFill 文件。
名稱	name	string	人員姓名

重新產生 Webhook 共用密碼

作業識別碼：: regenerateWebhookSecret

重新產生 Webhook 共用密碼

傳回

名稱	路徑	類型	Description
create_date	create_date	date-time
密碼	secret	b58

共用方式為

藍墨水

先決條件

如何取得認證

開始使用連接器

已知問題與限制

常見錯誤和補救措施

FAQ

正在建立連線

預設

節流限制

動作

列出 Webhook

參數

傳回

列出 WebhookEvents

參數

傳回

列出 WebhookEvents

參數

傳回

列出 WebhookExtraHeaders

參數

傳回

列出人員

參數

傳回

列出捆綁事件

參數

傳回

列出捆綁包

參數

傳回

列出文件範本

傳回

刪除 Webhook

參數

刪除 WebhookExtraHeader

參數

刪除人員

參數

取得 Webhook 共用密碼

傳回

取消捆綁包

參數

將標籤新增至套件組合

參數

建立 Webhook

參數

傳回

建立 WebhookExtraHeader

參數

傳回

建立人員

參數

傳回

建立內嵌簽署 URL

參數

傳回

建立套件組合

參數

從套件組合中移除標籤

參數

擷取 Webhook

參數

傳回

擷取 WebhookExtraHeader

參數

傳回

擷取人員

參數

傳回

擷取套件組合

參數

擷取套件組合檔案

參數

傳回

擷取套件組合資料

參數

傳回