Nitro Sign（預覽）

Nitro Sign API 透過應用程式建立、管理及追蹤數位簽章流程，實現安全且端到端的電子簽章工作流程。 它提供建立信封、上傳文件、新增參與者、定義簽署順序，以及透過全自動化 API 驅動方式傳送文件以供簽署的功能。

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

Service Class Regions
Copilot Studio 進階 除以下部分外，所有Power Automate區域：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
邏輯應用程式 標準 所有 Logic Apps 區域， 但下列區域除外：
     - Azure Government regions
     - Azure中國地區
     - 美國國防部 （DoD）
Power Apps 進階 除以下部分外，所有Power Apps區域
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
Power Automate（自動化服務） 進階 除以下部分外，所有Power Automate區域：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
聯絡方式
名稱 氮氣支援
URL https://www.gonitro.com/support
Email prosupport@sfdc.gonitro.com
連接器中繼資料
發行者 Nitro PDF
網站 https://www.gonitro.com/
隱私策略 https://www.gonitro.com/legal/privacy-policy
類別 生產力;資訊科技營運

硝基標誌連接器

概觀

Nitro Sign 連接器可直接從 Power Automate 和 Power Apps 實現安全、端對端的電子簽章工作流程。 它讓應用程式能建立與管理簽署信封、上傳與重新排序文件、新增參與者並定義簽署順序、放置簽名與資料欄位、傳送文件以供簽名、追蹤進度，以及下載原始、封存及稽核追蹤檔案——全部皆透過全自動化、API 驅動的方式完成。

Publisher： Nitro Software

先決條件

要透過此連接器使用 Nitro Sign，您需要：

Authentication

Nitro Sign 使用機器 對機器 OAuth 2.0 並授權客戶 端憑證 來產生 API 請求的存取權杖。

運作原理

  • 你在 Nitro 的自助入口網站建立一個 API 應用程式，並取得相關的客戶端 ID 和客戶端秘密。
  • 連接器透過將這些憑證交換為 持有人 存取權杖來進行認證。
  • 該令牌接著用來授權後續的 Nitro Sign API 呼叫。

建立憑證並閱讀詳細指南：
https://developers.gonitro.com/docs/authentication/credentials

在 Power Automate / Power Apps 中建立連線

將連接器加入流程或應用程式時：

  1. 點擊 新增連線。
  2. 輸入你的 客戶 ID 和 客戶機密 （在 Nitro 開發者入口網站中發布）。
  3. 請選擇您的 Nitro 區域（歐洲、美國 或 APAC）— 與您的 Nitro 帳戶相關聯的區域。
  4. 儲存連線——首次使用時，連接器會用 OAuth 2.0 用戶端憑證授權，將你的客戶端 ID 和客戶端秘密換成一個短暫的存取權杖，並自動快取並更新。 你的憑證只用來取得該代幣;後續的 API 呼叫會以承載憑證代為認證。

注意：無需使用者互動式登入;此流程設計用於伺服器對伺服器/應用程式對應用程式的情境。

支援的作業

連接器將動作圍繞簽署工作流程的四個資源—— 信封、 文件、 欄位與 參與者 ——以及一組用於取回完成檔案的 下載 動作來分組。

1. 信封

信封是單一簽署請求中文件、參與者及欄位的容器。

  • 名單信封
    回傳帳戶中所有與申請相關的信封。 結果會分頁：回應包含一個 「下一頁 游標」標記，你可以將它輸入可選的 「Page After 」參數以取得下一頁（或 「前頁 」以倒向翻頁）。 兩個游標參數都屬於 進階 ，僅在瀏覽大型結果集時才需要。

  • 建立信封
    建立一個新信封，包含名稱、通知訊息（主旨 + 正文，動態變數如 $(sender_name_or_email) 和 $(envelope_name)），以及簽署模式：

    • parallel — 所有參與者會同時收到通知，並可獨立簽署。
    • sequential — 參與者依加入順序，依照被加入的順序，逐一收到通知。

  • 依ID取得信封
    透過 UUID 取得特定信封的詳細資訊。

  • 更新信封
    更新信封名稱、通知設定和/或簽署模式。 所有欄位都是選擇性的。

  • 依 ID 刪除信封
    永久刪除信封及所有相關文件、欄位和參與者。 這無法逆轉。

  • 寄信封簽名
    將信封寄給參與者簽名。 在寄出前，信封通常應先加入文件、參與者及簽署欄位（透過「 依信封 ID 建立文件」、「 依信封 ID 建立參與者」及「 依文件 ID 建立欄位」）。 信封內所有文件必須先有上傳狀態，才能寄出。

  • 發送信封提醒
    觸發對待處理參與者的提醒通知。 若未提供通知設定，則使用該信封預設的通知範本。

  • 以ID取消信封
    取消簽約請求。 只有已送出簽名的信封才能被取消。

2. 文件

文件是附在信封上的檔案，由參與者簽名。

  • 依信封ID列出文件
    取回所有與信封相關的文件。

  • 以信封 ID 建立文件
    將文件上傳到現有信封。 提供檔案及簡單打字欄位——不使用手寫 JSON：

    • 文件檔案 — 需上傳的檔案。
    • 文件名稱 — 用來存放文件的名稱。
    • 內容類型（進階，選用） — 檔案的 MIME 類型;預設為 application/pdf。 若省略，則僅接受 PDF 檔案。

  • 依身分證取得文件
    在信封中取得特定文件的詳細資訊。

  • 依 ID 更新文件
    更新文件元資料。 目前，僅能更改文件名稱。

  • 依 ID 刪除文件
    永久刪除信封中的文件。

  • 依信封ID重新排序文件
    根據提供的文件識別碼清單重新排序信封中的文件。

3. 場

欄位是放置在文件上並指派給參與者的互動元素（簽名、縮寫、日期等）。

  • 依文件 ID 列出欄位
    擷取與特定文件相關的所有欄位。

  • 依文件識別建立欄位
    在文件中建立一個或多個欄位，並將其指派給參與者。 為單一欄位提供一項，或為大量申請提供多件。 每個欄位指定：

    • participantID —— 指派到現場的參與者。
    • type— 其中signature之一 ， initials， name， datecompanytitlecheckbox， ， 。 custom
    • page — 頁碼（以1為基礎的索引）。
    • X 位置、 Y 位置、 寬度、 高度 — 欄位的位置與大小，分別以點數輸入（X/Y 從頁面左上邊緣測量）。 這些組合取代了先前的單一 boundingBox 陣列，因此每個值在使用者介面中都是有型的欄位，而非手工建立的清單。
    • 可選： required （預設 true），以及 — 在 進階 — format （例如 MM/DD/YYYY 日期欄位）和 modifiable。

  • 依 ID 更新欄位
    更新現有欄位的屬性。 type欄位必須被提供且必須與現有欄位類型相符——它用來識別欄位結構，且不會改變欄位類型。

  • 依 ID 刪除欄位
    永久刪除文件中的欄位。

4. 參與者

參與者是收到信封的人——無論是簽名還是隨時獲得資訊。

  • 依信封編號列出參與者名單
    檢索所有與信封相關的參與者。

  • 透過 Envelope ID 建立參與者
    將一位或多位參與者加入信封。 為單一參與者提供一項，或為大量申請提供多件。 每位參與者具體說明：

    • email — 參與者的電子郵件地址。
    • role — signer （可指定欄位用於簽名）或 cc （唯讀存取）。
    • authentication （進階、可選） — 目前存取 碼：參與者在簽署前必須提供的靜態存取碼。 只有當參與者在簽名前需驗證時，才可開啟此區。

  • 依ID更新參與者
    更新參與者的認證設定。 參與者的電子郵件無法更改。

  • 依 ID 刪除參與者
    永久刪除信封中的參與者。

5. 下載內容

文件簽署並蓋章後，取回完成的檔案。

  • 下載原始信封
    從信封下載原始未簽署文件，作為 ZIP 壓縮檔。

  • 下載密封信封
    下載已封存的簽署文件及稽核追蹤，作為 ZIP 壓縮檔。

  • 依ID下載密封文件
    下載一份密封簽署的文件，格式為 PDF 檔案。

  • 下載Envelope的稽核追蹤
    下載信封的完整稽核追蹤檔案為 PDF 檔案。

下載動作會暴露選擇器原生的 檔案名稱 與 檔案內容 標記（以及 檔案內容類型）。 將檔案內容直接放入下游步驟的檔案輸入——例如 OneDrive / SharePoint 建立檔案——並將檔案名稱放入其檔名輸入中。 不需要body('Action_Name')表達式或手動輸入檔名;連接器會將下載的 ZIP 或 PDF 包裝成 JSON 信封，因此 Power Automate 會將這些檔案呈現為一般動態內容標記。

典型簽署流程

完整的簽名流程會依序串連上述動作。 一個常見的 Power Automate 流程如下：

  1. 建立信封 — 設定姓名、通知主體/主體及簽署模式（parallel 或 sequential）。 保存退回的 信封身份證。
  2. 依信封 ID 建立文件 — 將一個或多個檔案上傳到信封（使用步驟 1 的信封 ID）。 儲存每一個回傳 的文件ID。
    （可選）依信封 ID 重新排序文件 — 設定文件順序。
  3. 依信封ID建立參與者 — 新增簽署人與信用卡收件人及其存取碼認證。 儲存每位退回 的參與者身份證。
  4. 依文件 ID 建立欄位 — 在每份文件上放置簽名/日期等欄位，並指派給參與者（使用步驟 2 的文件 ID 及步驟 3 的參與者 ID）。
  5. 寄送信封簽名—— 寄出信封。 所有文件必須先處於上傳狀態。
  6. （待處理期間）發送提醒讓信封 提醒以推動參與者，或 以ID取消信封 以停止請求。
  7. （完成後）下載密封信封 / 按ID / 下載封存文件下載信封稽核追蹤以取回完成的檔案。

提示：創建動作回傳的信封 ID、文件 ID 和參與者 ID 會自然流向後續的 Power Automate 動態內容選擇器——從上游動作中選擇 ID 標記，而不是直接輸入。

錯誤與節流

Nitro Sign API 可能會回傳以下錯誤：

  • 400 — 不好的請求
  • 401 — 未經授權
  • 404 — 未找到
  • 409 — 衝突 （例如在不允許操作的狀態下作用於包絡）
  • 413 — 內容過大
  • 415 — 不支援媒體類型
  • 422 — 不可處理實體
  • 500 — 內部伺服器錯誤

節流

  • 每個連線的 API 呼叫數：每 60 秒100 次。

月台限制

檔案大小

  • 最高： 每個請求 25 MB
    適用於單檔及多檔操作。

頁數

  • 每 份文件最多250頁
    多份文件的總頁數可能超過250頁。

保留時間

  • 輸入與輸出檔案在操作完成後 ~ 15 分鐘 內被刪除。

備註

  • 信封、文件、欄位及參與者管理操作回傳 JSON。
  • 下載動作會回傳檔案（ZIP 或 PDF），包裹在 JSON 封裝中，顯示 檔案名稱、 檔案內容類型及 檔案內容 作為選擇器原生標記，因此結果可串連成下游檔案動作，無需表達式。
  • 簽署模式（parallel 與 sequential）是在建立信封時設定，並可在信封寄出前透過 更新信封 進行更改。
  • 參與者認證目前僅支援 存取碼 。

正在建立連線

連接器支援下列驗證類型：
預設值 建立連線的參數。 所有地區 不可共享

預設

適用：所有地區

建立連線的參數。

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

名稱 類型 Description Required
Nitro 客戶端識別碼 安全字串 您的 Nitro 應用程式客戶端 ID 沒錯
Nitro 客戶端祕密 安全字串 您的 Nitro 應用程式 客戶端秘密 沒錯
硝基區域 字串 請選擇您的帳戶的 Nitro API 區域。 沒錯

動作

下載Envelope的稽核追蹤

下載包含所選 Nitro Sign 信封完整稽核紀錄的 PDF 檔案。
下載原始信封

從 Nitro Sign 信封下載原始未簽名文件，作為 ZIP 壓縮檔。
下載密封信封

從 Nitro Sign 信封下載密封簽署文件及稽核紀錄，作為 ZIP 壓縮檔。
以ID取消信封

取消了Nitro Sign信封的簽名申請。 只有已送出簽名的信封才會被取消。
以信封 ID 建立文件

將文件上傳至現有的 Nitro Sign 信封。 該文件之後可用於簽署流程。
依 ID 刪除信封

永久刪除 Nitro Sign 信封。 此操作無法撤銷，所有相關文件、欄位及參與者也會被刪除。
依 ID 刪除參與者

永久刪除 Nitro Sign 信封中的參與者。
依 ID 刪除文件

永久刪除 Nitro Sign 信封中的文件。
依 ID 刪除欄位

永久刪除 Nitro Sign 信封內文件中的欄位。
依 ID 更新文件

更新 Nitro Sign 信封內現有文件的元資料。 目前，只有文件名稱可以更新。
依 ID 更新欄位

更新 Nitro Sign 文件中現有欄位的屬性。 欄位類型必須提供，且必須與現有欄位類型相符;API 用它來識別欄位結構，且不會改變欄位類型。
依ID下載密封文件

從 Nitro Sign 信封下載一份密封簽署文件，作為 PDF 檔案。
依ID取得信封

利用該 Nitro Sign 信封的唯一信封 ID 取得詳細資訊。
依ID更新參與者

更新 Nitro Sign 信封中參與者的認證設定。 參與者的電子郵件無法更新。
依信封ID列出文件

檢索與特定 Nitro Sign 信封相關的所有文件。
依信封ID重新排序文件

根據提供的文件識別碼清單，重新排序與特定 Nitro Sign 信封相關的文件。
依信封編號列出參與者名單

檢索所有與特定 Nitro Sign 信封相關的參與者。
依文件 ID 列出欄位

可檢索 Nitro Sign 信封內與特定文件相關的所有欄位。
依文件識別建立欄位

在文件中建立一個或多個欄位，並將其指派給參與者。 要建立單一欄位，請在 Fields 陣列中提供一個項目。 要建立多個欄位，請提供多個項目。
依身分證取得文件

可檢索特定文件的詳細資訊，存放於 Nitro Sign 信封中。
名單信封

List Envelopes 端點會回傳帳戶中與應用程式相關的所有信封。
寄信封簽名

寄送 Nitro Sign 信封給參與者簽名。 在使用此操作前，信封通常應先新增文件、參與者及簽署欄位，分別使用「依信封 ID 建立文件」、「依信封 ID 建立參與者」及「依文件 ID 建立欄位」。 信封內所有文件必須先有上傳狀態，才能寄出。
建立信封

建立一個新的 Nitro Sign 信封，之後可裝入文件、參與者、欄位並送交簽名。
更新信封

更新現有的 Nitro Sign 信封。 你可以修改信封名稱、通知設定、簽名模式，或是這些欄位的任意組合。
發送信封提醒

觸發提醒通知待參加者指定 Nitro Sign 信封。 若未提供通知設定，則使用該信封預設的通知範本。
透過 Envelope ID 建立參與者

將一名或多名參與者加入氮氣標誌信封。 若要新增單一參與者，請在 Participants 陣列中提供一個項目。 要增加多位參與者，請提供多個項目。

下載Envelope的稽核追蹤

作業識別碼：
DownloadAuditTrailOfEnvelope

下載包含所選 Nitro Sign 信封完整稽核紀錄的 PDF 檔案。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別應該下載稽核追蹤的信封。

傳回

下載了封裝成 JSON 信封的檔案。

身體
FileDownloadResponse

下載原始信封

作業識別碼：
DownloadOriginalEnvelope

從 Nitro Sign 信封下載原始未簽名文件，作為 ZIP 壓縮檔。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別應該下載原始文件的信封。

傳回

下載了封裝成 JSON 信封的檔案。

身體
FileDownloadResponse

下載密封信封

作業識別碼：
DownloadSealedEnvelope

從 Nitro Sign 信封下載密封簽署文件及稽核紀錄，作為 ZIP 壓縮檔。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別應該下載其密封文件的信封。

傳回

下載了封裝成 JSON 信封的檔案。

身體
FileDownloadResponse

以ID取消信封

作業識別碼：
CancelEnvelopeByID

取消了Nitro Sign信封的簽名申請。 只有已送出簽名的信封才會被取消。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別要取消的包絡線。

傳回

在請求或建立 Nitro Sign 信封後，回覆會回傳。

身體
EnvelopeResponse

以信封 ID 建立文件

作業識別碼：
CreateDocumentByEnvelopeID

將文件上傳至現有的 Nitro Sign 信封。 該文件之後可用於簽署流程。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別文件將上傳的信封。
文件名稱
 documentName True string

要上傳的文件名稱。 這個值將用來建立傳送到 Nitro 的文件元資料。
內容類型
 contentType string

上傳文件的內容類型。 PDF 檔案請使用 application/pdf。 當 從元資料中省略時，僅接受 PDF 檔案。
文件檔案
 payload True file

要上傳到信封的文件檔案。

傳回

名稱 路徑 類型 Description
文件識別碼
 ID uuid

一個獨特的 UUID，用來識別上傳的文件。
文件名稱
 name string

上傳文件的名稱。
創立於
 createdAt string

時間戳記顯示文件建立的時間。
文件狀態
 status string

上傳文件的處理狀態。

依 ID 刪除信封

作業識別碼：
DeleteEnvelopeByID

永久刪除 Nitro Sign 信封。 此操作無法撤銷，所有相關文件、欄位及參與者也會被刪除。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別要刪除的信封。

依 ID 刪除參與者

作業識別碼：
DeleteParticipantByID

永久刪除 Nitro Sign 信封中的參與者。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別包含參與者的信封。
參與者標識碼
 participantID True uuid

一個獨特的 UUID，用來識別要刪除的參與者。

依 ID 刪除文件

作業識別碼：
DeleteDocumentByID

永久刪除 Nitro Sign 信封中的文件。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別包含文件的信封。
文件識別碼
 documentID True uuid

一個獨特的 UUID，用來識別要刪除的文件。

依 ID 刪除欄位

作業識別碼：
DeleteFieldByID

永久刪除 Nitro Sign 信封內文件中的欄位。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別包含文件的信封。
文件識別碼
 documentID True uuid

一個唯一用來識別包含該欄位的文件的 UUID。
欄位識別碼
 fieldID True uuid

一個獨特的 UUID，用來識別要刪除的欄位。

依 ID 更新文件

作業識別碼：
UpdateDocumentByID

更新 Nitro Sign 信封內現有文件的元資料。 目前，只有文件名稱可以更新。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別包含文件的信封。
文件識別碼
 documentID True uuid

一個獨特的 UUID，用來識別要更新的文件。
文件名稱
 name True string

文件的新名稱。

傳回

Nitro Sign 文件細節。

身體
DocumentResponse

依 ID 更新欄位

作業識別碼：
UpdateFieldByID

更新 Nitro Sign 文件中現有欄位的屬性。 欄位類型必須提供，且必須與現有欄位類型相符;API 用它來識別欄位結構，且不會改變欄位類型。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別包含文件的信封。
文件識別碼
 documentID True uuid

一個唯一用來識別包含該欄位的文件的 UUID。
欄位識別碼
 fieldID True uuid

一個獨特的 UUID，用來識別要更新的欄位。
欄位類型
 type True string

目前正在更新欄位的類型。 此值為 API 要求，且必須與現有欄位類型相符;它不會改變欄位類型。
參與者標識碼
 participantID uuid

分配到該欄位的參與者唯一識別碼。
頁面
 page integer

欄位出現的頁碼。 頁面採用基於 1 的索引。
X 位置
 x float

Optional. 從頁面左邊起，以點數計算的欄位水平位置。
Y 位置
 y float

Optional. 從頁面頂端開始，以點數計算的欄位垂直位置。
寬度
 width float

Optional. 以積分計算的場地寬度。
高度
 height float

Optional. 以積分計算的場地高度。
Required
 required boolean

表示參與者是否必須完成此欄位。
Format
 format string

現場格式（如適用）。 例如，日期欄位可以使用 MM/DD/YYYY 等格式。
可修改
 modifiable boolean

表示欄位值是否可修改（如適用）。

傳回

Nitro Sign 場地詳情。

身體
FieldResponse

依ID下載密封文件

作業識別碼：
DownloadSealedDocumentByID

從 Nitro Sign 信封下載一份密封簽署文件，作為 PDF 檔案。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別裝有密封文件的信封。
文件識別碼
 documentID True uuid

一個獨特的 UUID，用來識別封存文件可供下載。

傳回

下載了封裝成 JSON 信封的檔案。

身體
FileDownloadResponse

依ID取得信封

作業識別碼：
GetEnvelopeByID

利用該 Nitro Sign 信封的唯一信封 ID 取得詳細資訊。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別要檢索的信封。

傳回

在請求或建立 Nitro Sign 信封後，回覆會回傳。

身體
EnvelopeResponse

依ID更新參與者

作業識別碼：
UpdateParticipantByID

更新 Nitro Sign 信封中參與者的認證設定。 參與者的電子郵件無法更新。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別包含參與者的信封。
參與者標識碼
 participantID True uuid

一個獨特的 UUID，用來識別要更新的參與者。
驗證類型
 type string

Optional. 為參與者選擇一種認證方式。 如有指定，也應提供存取碼。
存取代碼
 accessCode string

僅在指定認證類型時才需要。 若不需參與者認證，請留空。

傳回

Nitro Sign 參與者詳情。

身體
ParticipantResponse

依信封ID列出文件

作業識別碼：
ListDocumentsByEnvelopeID

檢索與特定 Nitro Sign 信封相關的所有文件。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別應該取回文件的信封。

傳回

當列出與 Nitro Sign 信封相關的文件時，回覆回覆會回來。

身體
ListDocumentsByEnvelopeIDResponse

依信封ID重新排序文件

作業識別碼：
ReorderDocumentsByEnvelopeID

根據提供的文件識別碼清單，重新排序與特定 Nitro Sign 信封相關的文件。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別應重新排序文件的信封。
文件識別碼
 order True array of uuid

一組文件 ID 陣列，代表信封內文件的新排列順序。

傳回

當列出與 Nitro Sign 信封相關的文件時，回覆回覆會回來。

身體
ListDocumentsByEnvelopeIDResponse

依信封編號列出參與者名單

作業識別碼：
ListParticipantsByEnvelopeID

檢索所有與特定 Nitro Sign 信封相關的參與者。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別應被檢索的信封。

傳回

當列出與 Nitro Sign 信封相關的參與者時，回應會返回。

身體
ParticipantsListResponse

依文件 ID 列出欄位

作業識別碼：
ListFieldsByDocumentID

可檢索 Nitro Sign 信封內與特定文件相關的所有欄位。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別包含文件的信封。
文件識別碼
 documentID True uuid

一個獨特的 UUID，用來識別應被檢索欄位的文件。

傳回

建立一個或多個欄位後，回應會返回。

身體
FieldsResponse

依文件識別建立欄位

作業識別碼：
CreateFieldsByDocumentID

在文件中建立一個或多個欄位，並將其指派給參與者。 要建立單一欄位，請在 Fields 陣列中提供一個項目。 要建立多個欄位，請提供多個項目。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別信封。
文件識別碼
 documentID True uuid

一個獨特的 UUID，用來識別應建立欄位的文件。
參與者標識碼
 participantID True uuid

分配到該欄位的參與者唯一識別碼。
頁面
 page True integer

欄位應該放置的頁碼。 頁面採用以 1 為基礎的索引，因此第一頁是 1。
欄位類型
 type True string

該創造的領域類型。
X 位置
 x True float

從頁面左邊起，以點數計算的欄位水平位置。
Y 位置
 y True float

從頁面頂端開始，以點數計算的欄位垂直位置。
寬度
 width True float

以積分計算的場地寬度。
高度
 height True float

以積分計算的場地高度。
Required
 required boolean

表示參與者是否必須完成此欄位。
Format
 format string

支援格式化欄位的可選格式，例如日期欄位。 範例：MM/DD/YYYY。
可修改
 modifiable boolean

表示參與者是否能修改欄位值，若欄位類型支持。

傳回

建立一個或多個欄位後，回應會返回。

身體
FieldsResponse

依身分證取得文件

作業識別碼：
GetDocumentByID

可檢索特定文件的詳細資訊，存放於 Nitro Sign 信封中。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別包含文件的信封。
文件識別碼
 documentID True uuid

一個獨特的 UUID，用來識別要檢索的文件。

傳回

Nitro Sign 文件細節。

身體
DocumentResponse

名單信封

作業識別碼：
ListEnvelopes

List Envelopes 端點會回傳帳戶中與應用程式相關的所有信封。

參數

名稱 機碼 必要 類型 Description
之後的頁面
 pageAfter string

可選的游標標記用於檢索下一頁信封。 使用前一個回應回傳的 nextPage 值。
前頁
 pageBefore string

可選的游標標記用於檢索上一頁信封。 請勿與 Page After 一起使用。

傳回

名稱 路徑 類型 Description
信封
 items array of EnvelopeSummaryResponse

信封清單。
下一頁
 nextPage string

游標標記，可用作「後頁」來檢索下一頁信封。

寄信封簽名

作業識別碼：
SendEnvelopeForSigning

寄送 Nitro Sign 信封給參與者簽名。 在使用此操作前，信封通常應先新增文件、參與者及簽署欄位，分別使用「依信封 ID 建立文件」、「依信封 ID 建立參與者」及「依文件 ID 建立欄位」。 信封內所有文件必須先有上傳狀態，才能寄出。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別要寄送簽名的信封。

傳回

關於 Nitro Sign 信封的摘要資訊。

身體
EnvelopeSummaryResponse

建立信封

作業識別碼：
CreateEnvelope

建立一個新的 Nitro Sign 信封，之後可裝入文件、參與者、欄位並送交簽名。

參數

名稱 機碼 必要 類型 Description
信封名稱
 name True string

信封的名字。 這不需要是唯一的。
簽署模式
 mode True string

定義簽署順序。 可使用平行通知所有參與者同時通知，或依加入順序逐一通知參與者。
通知主體
 subject True string

發送給簽署參與者的電子郵件通知主旨。 支援動態變數，例如：$（sender_name_or_email） 正在請求你的簽名。
通知本文
 body True string

發送給簽署參與者的電子郵件內容。 支援動態變數，例如：嗨，\n請簽名 $（envelope_name）\n謝謝，\n$（sender_name_or_email）。

傳回

在請求或建立 Nitro Sign 信封後，回覆會回傳。

身體
EnvelopeResponse

更新信封

作業識別碼：
UpdateEnvelope

更新現有的 Nitro Sign 信封。 你可以修改信封名稱、通知設定、簽名模式，或是這些欄位的任意組合。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別要更新的信封。
信封名稱
 name string

更新後的信封名稱。 這不需要是唯一的。
通知主體
 subject string

發送給簽署參與者的電子郵件通知主旨。 支援動態變數，例如：$（sender_name_or_email） 正在請求你的簽名。
通知本文
 body string

發送給簽署參與者的電子郵件內容。 支援動態變數，例如：嗨，\n請簽名 $（envelope_name）\n謝謝，\n$（sender_name_or_email）。
簽署模式
 mode string

定義簽署順序。 可使用平行通知所有參與者同時通知，或依加入順序逐一通知參與者。

傳回

在請求或建立 Nitro Sign 信封後，回覆會回傳。

身體
EnvelopeResponse

發送信封提醒

作業識別碼：
SendRemindersForEnvelope

觸發提醒通知待參加者指定 Nitro Sign 信封。 若未提供通知設定，則使用該信封預設的通知範本。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，用來識別應該發送提醒通知的信封。
通知主體
 subject string

發送給簽署參與者的電子郵件通知主旨。 支援動態變數，例如：$（sender_name_or_email） 正在請求你的簽名。
通知本文
 body string

發送給簽署參與者的電子郵件內容。 支援動態變數，例如：嗨，\n請簽名 $（envelope_name）\n謝謝，\n$（sender_name_or_email）。

透過 Envelope ID 建立參與者

作業識別碼：
CreateParticipantsByEnvelopeID

將一名或多名參與者加入氮氣標誌信封。 若要新增單一參與者，請在 Participants 陣列中提供一個項目。 要增加多位參與者，請提供多個項目。

參數

名稱 機碼 必要 類型 Description
信封 ID
 envelopeID True uuid

一個獨特的 UUID，標示應加入參與者的信封。
Email
 email True email

參與者的電子郵件位址。
Role
 role True string

參與者角色。 簽署者可以指定欄位供簽名使用。 CC 參與者擁有唯讀存取權限。
驗證類型
 type string

Optional. 為參與者選擇一種認證方式。 如有指定，也應提供存取碼。
存取代碼
 accessCode string

僅在指定認證類型時才需要。 若不需參與者認證，請留空。

傳回

建立一位或多位參與者後，回應會回傳。

身體
ParticipantsResponse

定義

EnvelopeNotification

Nitro Sign 信封的通知電子郵件設定。

名稱 路徑 類型 Description
通知主體
 subject string

發送給簽署參與者的電子郵件通知主旨。 支援動態變數，例如：$（sender_name_or_email） 正在請求你的簽名。
通知本文
 body string

發送給簽署參與者的電子郵件內容。 支援動態變數，例如：嗨，\n請簽名 $（envelope_name）\n謝謝，\n$（sender_name_or_email）。

信封摘要回應

關於 Nitro Sign 信封的摘要資訊。

名稱 路徑 類型 Description
信封 ID
 ID uuid

一個獨特的 UUID，用來識別信封。
創立於
 createdAt date-time

UTC 時間戳記顯示該包絡被建立的時間。
上次修改時間
 lastModifiedAt date-time

UTC 時間戳記，表示信封最後修改的時間。
信封名稱
 name string

信封的名字。
信封狀態
 status string

信封的內部狀態。

包絡響應

在請求或建立 Nitro Sign 信封後，回覆會回傳。

名稱 路徑 類型 Description
信封 ID
 ID uuid

一個獨特的 UUID，用來識別信封。
創立於
 createdAt date-time

UTC 時間戳記顯示該包絡被建立的時間。
上次修改時間
 lastModifiedAt date-time

UTC 時間戳記，表示信封最後修改的時間。
信封名稱
 name string

信封的名字。
信封狀態
 status string

信封的內部狀態。
簽署模式
 mode string

信封的簽名模式。
通知
 notification EnvelopeNotification

Nitro Sign 信封的通知電子郵件設定。

ListDocumentsByEnvelopeIDResponse

當列出與 Nitro Sign 信封相關的文件時，回覆回覆會回來。

名稱 路徑 類型 Description
Documents
 items array of DocumentResponse

與信封相關的文件清單。

文件回應

Nitro Sign 文件細節。

名稱 路徑 類型 Description
文件識別碼
 ID uuid

一個獨特的 UUID，用來識別該文件。
文件名稱
 name string

文件的名稱。
創立於
 createdAt date-time

UTC 時間戳記顯示文件建立的時間。
以位元組為單位的大小
 sizeBytes integer

文件大小以位元組為單位。
頁數
 numPages integer

文件的頁數。
文件狀態
 status string

文件的現況。

FieldsResponse

建立一個或多個欄位後，回應會返回。

名稱 路徑 類型 Description
Fields
 items array of FieldResponse

這個請求中建立的欄位。

現場回應

Nitro Sign 場地詳情。

名稱 路徑 類型 Description
欄位識別碼
 ID uuid

一個獨特的 UUID，用來識別該欄位。
參與者標識碼
 participantID uuid

分配到該欄位的參與者唯一識別碼。
文件識別碼
 documentID uuid

欄位所屬文件的唯一識別碼。
頁面
 page integer

欄位出現的頁碼。
周框方塊
 boundingBox array of float

一個由四個數字組成的陣列，格式為 [x， y， width， height]，以點數為單位。
Required
 required boolean

表示參與者是否必須完成此欄位。
欄位類型
 type string

欄位的類型。
Format
 format string

現場格式（如適用）。
可修改
 modifiable boolean

表示欄位值是否可修改（如適用）。

參與者回應

建立一位或多位參與者後，回應會回傳。

名稱 路徑 類型 Description
Participants
 items array of ParticipantResponse

參與者在此請求中創作。

參與者名單回應

當列出與 Nitro Sign 信封相關的參與者時，回應會返回。

名稱 路徑 類型 Description
Participants
 items array of ParticipantResponse

與信封相關的參與者。
總參賽人數
 total integer

收藏中可參與的總人數。

參與者回應

Nitro Sign 參與者詳情。

名稱 路徑 類型 Description
參與者標識碼
 ID uuid

一個獨特的UUID，用來識別參與者。
Email
 email email

參與者的電子郵件位址。
Role
 role string

參與者的角色。
認證
 authentication ParticipantAuthenticationResponse

參與者的認證設定回傳了。

參與者認證回應

參與者的認證設定回傳了。

名稱 路徑 類型 Description
驗證類型
 type string

參與者認證類型。
存取代碼
 accessCode string

為參與者設定的存取碼。

檔案下載回應

下載了封裝成 JSON 信封的檔案。

名稱 路徑 類型 Description
檔案名稱
 fileName string

下載檔案名稱，源自回應的 Content-Disposition 標頭（例如 result.zip 或 result.pdf）。 將此權杖直接插入下游動作（如 OneDrive 或 SharePoint）的檔案名稱輸入，建立檔案。
檔案內容類型
 fileContentType string

下載檔案的 MIME 類型，例如 application/zip 或 application/pdf。
檔案內容
 fileContent byte

base64 編碼的檔案內容。 將此標記直接放入下游動作的檔案內容輸入（例如 OneDrive 或 SharePoint 建立檔案，或其他 Nitro 動作）——不需要表達式。