Nitro Sign (プレビュー)
Nitro Sign API を使用すると、アプリケーションでデジタル署名プロセスを作成、管理、追跡できるため、セキュリティで保護されたエンドツーエンドの eSignature ワークフローが可能になります。 完全に自動化された API 駆動型アプローチを使用して、封筒の作成、ドキュメントのアップロード、参加者の追加、署名順序の定義、署名用のドキュメントの送信を行う機能を提供します。
このコネクタは、次の製品とリージョンで使用できます。
| Service | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべてのPower Automateリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - 中国リージョンAzure - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべてのPower Appsリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate（パワーオートメート） | Premium | 次を除くすべてのPower Automateリージョン: - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Contact | |
|---|---|
| 名前 | Nitro のサポート |
| URL | https://www.gonitro.com/support |
| prosupport@sfdc.gonitro.com |
| コネクタ メタデータ | |
|---|---|
| 発行者 | Nitro PDF |
| ウェブサイト | https://www.gonitro.com/ |
| プライバシー ポリシー | https://www.gonitro.com/legal/privacy-policy |
| カテゴリ | 生産性;IT 運用 |
Nitro Sign コネクタ
概要
Nitro Sign コネクタを使用すると、Power AutomateとPower Appsから直接、セキュリティで保護されたエンドツーエンドの eSignature ワークフローが可能になります。 これにより、アプリケーションは、署名エンベロープの作成と管理、ドキュメントのアップロードと並べ替え、参加者の追加と署名順序の定義、署名とデータ フィールドの配置、署名用のドキュメントの送信、進行状況の追跡、元のファイル、シールされたファイル、監査証跡ファイルのダウンロードなどを、すべて完全に自動化された API 駆動型アプローチで行うことができます。 フローは、Nitro Sign で何かが発生したときに発生する トリガー によって自動的に開始することもできます。
Publisher: Nitro Software
前提条件
このコネクタで Nitro Sign を使用するには、次のものが必要です。
- Nitro Sign が有効になっている Nitro アカウント
https://developers.gonitro.com/ - カスタム コネクタ機能を備えたMicrosoft PowerAppsまたはPower Automateプラン。
Authentication
Nitro Sign は、クライアント資格情報の付与を使用してマシン間 OAuth 2.0 を使用して、API 要求のアクセス トークンを生成します。
どのように機能するのか
- Nitro のセルフサービス ポータルで API アプリケーションを作成し、関連付けられているクライアント ID とクライアント シークレットを取得します。
- コネクタは、 ベアラー アクセス トークンに対してこれらの資格情報を交換することで認証を行います。
- トークンは、その後の Nitro Sign API 呼び出しを承認するために使用されます。
資格情報を作成し、詳細なガイドをお読みください。
https://developers.gonitro.com/docs/authentication/credentials
Power Automate/Power Appsでの接続の作成
フローまたはアプリにコネクタを追加する場合:
- [ 新しい接続の追加] をクリックします。
- クライアント ID とクライアント シークレット (Nitro 開発者ポータルで発行) を入力します。
- Nitro アカウントに関連付けられているリージョンである Nitro リージョン (ヨーロッパ、米国、または APAC) を選択します。
- 接続を保存します。最初に使用すると、コネクタは OAuth 2.0 クライアント資格情報の付与を使用してクライアント ID とクライアント シークレットを有効期間の短いアクセス トークンと交換し、キャッシュし、自動的に更新します。 資格情報はトークンの取得にのみ使用されます。後続の API 呼び出しは、ユーザーに代わってベアラー トークンを使用して認証されます。
注: ユーザー対話型サインインは必要ありません。このフローは、サーバー間/アプリ間のシナリオ向けに設計されています。
サポートされている操作
コネクタは、署名ワークフローの 4 つのリソース ( エンベロープ、 ドキュメント、 フィールド、 参加者 ) に加えて、完了したファイルを取得するための 一 連のダウンロード アクションと、Nitro Sign でイベントが発生したときにフローを開始する トリガー のセットをグループ化します。
1. 封筒
封筒は、1 つの署名要求のドキュメント、参加者、フィールドのコンテナーです。
封筒を一覧表示する
アカウント内のアプリケーションに関連付けられているすべての封筒を返します。 結果はページ分割されます。応答には 次のページ カーソル トークンが含まれています。このトークンを省略可能な Page After パラメーターに指定して、次のページを取得できます (または 、ページの前 からページに戻ります)。 どちらのカーソル パラメーターも Advanced の下にあり、大きな結果セットを移動する場合にのみ必要です。封筒を作成する
名前、通知メッセージ (件名 + 本文、$(sender_name_or_email)や$(envelope_name)などの動的変数を含む)、署名モードを含む新しいエンベロープを作成します。-
parallel— すべての参加者が同時に通知を受け取り、個別に署名できます。 -
sequential— 参加者は、追加された順序で一度に 1 つずつ通知されます。
-
ID で封筒を取得する
UUID によって特定のエンベロープの詳細を取得します。エンベロープの更新
エンベロープ名、通知設定、署名モードを更新します。 すべてのフィールドは省略可能です。ID で封筒を削除する
封筒と、関連付けられているすべてのドキュメント、フィールド、および参加者を完全に削除します。 これは元に戻すことはできません。署名用封筒を送信する
署名コレクションの参加者に封筒を送信します。 通常、封筒にドキュメント、参加者、署名フィールドを追加する必要があります (封筒 ID によるドキュメントの作成、封筒 ID による参加者の作成、ドキュメント ID によるフィールドの作成)。 封筒内のすべてのドキュメントは、封筒を送信する前にアップロード済みの状態である必要があります。封筒のリマインダーを送信する
保留中の参加者にリマインダー通知をトリガーします。 通知設定が指定されていない場合は、エンベロープ用に構成された既定の通知テンプレートが使用されます。ID による封筒の取り消し
署名要求を取り消します。 署名用に既に送信されている封筒のみを取り消すことができます。
2. ドキュメント
ドキュメントは、封筒に添付され、参加者によって署名されたファイルです。
封筒 ID でドキュメントを一覧表示する
封筒に関連付けられているすべてのドキュメントを取得します。封筒 ID でドキュメントを作成する
既存の封筒にドキュメントをアップロードします。 ファイルに加えて、手動で書き込まれた JSON を使用しない単純な型指定されたフィールドを指定します。- ドキュメント ファイル — アップロードするファイル。
- [ドキュメント名] — ドキュメントを格納する名前。
-
コンテンツ タイプ(詳細、省略可能) - ファイルの MIME の種類。は既定で
application/pdfに設定されます。 省略すると、PDF ファイルのみが使用できます。
ID でドキュメントを取得する
封筒内の特定のドキュメントの詳細を取得します。ID によるドキュメントの更新
ドキュメント メタデータを更新します。 現在、変更できるのはドキュメント名のみです。ID によるドキュメントの削除
封筒から文書を完全に削除します。封筒 ID でドキュメントを並べ替える
指定されたドキュメント ID の一覧に基づいて、封筒内のドキュメントの順序を変更します。
3. フィールド
フィールドは、ドキュメントに配置され、参加者に割り当てられる対話型要素 (署名、イニシャル、日付など) です。
ドキュメント ID でフィールドを一覧表示する
特定のドキュメントに関連付けられているすべてのフィールドを取得します。ドキュメント ID でフィールドを作成する
ドキュメントに 1 つ以上のフィールドを作成し、参加者に割り当てます。 1 つのフィールドに 1 つの項目を指定するか、一括要求に対して複数の項目を指定します。 各フィールドは次を指定します。-
participantID— フィールドに割り当てられた参加者。 -
type—signature、initials、name、date、title、company、checkbox、customのいずれか。 -
page— ページ番号 (1 から始まるインデックス作成)。 -
X 位置、 Y 位置、 幅、 高さ — フィールドの位置とサイズ。それぞれをポイント単位で個別の数値として入力します (X/Y はページの左端または上端から測定されます)。 これらは前の単一の
boundingBox配列を置き換えるので、各値は手動で作成されたリストではなく、UI の型指定されたフィールドになります。 - 省略可能:
required(既定のtrue)、および [ 詳細設定 ] の下のformat(日付フィールドのMM/DD/YYYYなど) とmodifiable。
-
ID でフィールドを更新する
既存のフィールドのプロパティを更新します。 フィールドtypeを指定し、既存のフィールド型と一致する必要があります。フィールド スキーマを識別するために使用され、フィールドの種類は変更 されません 。ID によるフィールドの削除
文書からフィールドを完全に削除します。
4. 参加者
参加者は封筒を受け取る人であり、署名するか、通知を受け取ります。
エンベロープ ID で参加者を一覧表示する
封筒に関連付けられているすべての参加者を取得します。封筒 ID で参加者を作成する
封筒に 1 人以上の参加者を追加します。 1 つの参加者に 1 つの項目を指定するか、一括要求に対して複数の項目を指定します。 各参加者は次を指定します。-
email— 参加者のメール アドレス。 -
role—signer(署名用にフィールドを割り当てることができます) またはcc(読み取り専用アクセス)。 -
authentication(詳細、省略可能) — 現在 のアクセス コード: 署名前に参加者が指定する必要がある静的アクセス コード。 署名する前に参加者が認証する必要がある場合にのみ、このセクションを開きます。
-
ID による参加者の更新
参加者の認証設定を更新します。 参加者のメールは変更できません。ID による参加者の削除
封筒から参加者を完全に削除します。
5. ダウンロード
ドキュメントの署名とシールが完了したら、完成したファイルを取得します。
元の封筒をダウンロードする
封筒から元の署名されていないドキュメントを ZIP アーカイブとしてダウンロードします。封印された封筒をダウンロードする
シールされた署名済みドキュメントと監査証跡を ZIP アーカイブとしてダウンロードします。ID で封印されたドキュメントをダウンロードする
1 つの封印された署名付きドキュメントを PDF ファイルとしてダウンロードします。封筒の監査証跡をダウンロードする
封筒の完全な監査証跡を PDF ファイルとしてダウンロードします。
ダウンロード アクションでは、ピッカーネイティブの ファイル名 トークンと ファイル コンテンツ トークン (および ファイル コンテンツ タイプ) が公開されます。 ファイル コンテンツをダウンストリーム ステップのファイル入力 (OneDrive/SharePoint ファイルの作成など) に直接ドロップし、ファイル名の入力にファイル名を入力します。
body('Action_Name')式や手動で型指定されたファイル名は必要ありません。コネクタは、ダウンロードした ZIP または PDF を JSON エンベロープにラップするため、通常の動的コンテンツ トークンとして表示Power Automate。
6. トリガー
トリガーは、Nitro Sign で何かが発生したときに自動的にフローを開始するため、変更をポーリングする必要はありません。 フローの最初のステップとしてトリガーを選択します。その後、そのイベントが発生するたびに、Nitro Sign によってPower Automateに通知されます。
構成するものは何もありません。入力するイベント名も、貼り付けるコールバック URL もありません。 フローをオンにすると、サブスクリプションが Nitro Sign に登録されます。
エンベロープ ライフサイクル トリガー
封筒が作成されたとき新しいエンベロープが作成されたときに発生します。たとえば、新しい署名要求をすべてSharePoint listに記録したり、要求が下書きされたことをチャネルに通知したりします。
署名用に封筒が送信されたとき エンベロープが署名ワークフローに入り、参加者に通知されると発生します。
封筒署名が完了したとき すべての参加者が署名し、シールが開始されると発生します。
封筒がシールされている場合 封筒がシールされ、それ以上変更できない場合に発生します。 これは、完成したファイルを取得するための通常のトリガーです。
封筒が取り消されたとき 署名要求が取り消されたときに発生します。
参加者トリガー
署名要求が署名されたとき 個々の参加者が署名するたびに起動します。 マルチ署名者エンベロープでは、署名者ごとに 1 回発生するため、進行状況の追跡に役立ちます。
署名要求が拒否されたとき 参加者が署名を拒否すると発生します。通常は、送信者に警告したり、例外プロセスを開始したりするために使用されます。
トリガーによって提供される内容
すべてのトリガーは、イベントの詳細と関連するエンベロープを出力し、通常の動的コンテンツ トークンとして使用できます。
イベントの種類、 イベント ID、 発生日時 (UTC) — 発生日時。 イベント ID はイベントごとに一意であり、重複を検出するために使用できます。
アカウント ID、 アプリケーション ID、 Webhook 構成 ID — 通知の背後にある Nitro アカウント、アプリケーション、サブスクリプション。
エンベロープ ID、 エンベロープ名 — イベントが関連するエンベロープ。 封筒 ID を直接送り、ID で封筒を取得したり、封筒をダウンロードしたりするなどのフォローアップ アクションに入ります。
署名、署名、拒否、取り消しのために送信された 5 つの署名ワークフロー トリガーは、さらに次のように出力されます。
ドキュメント — 封筒内のドキュメント (ドキュメント ID、ドキュメント名、ページ、ファイル サイズ、配信元)。
署名要求 - 参加者 ID、 署名者の電子メール、 署名者名、署名者の 姓、 状態、 署名順序を持つ参加者ごとに 1 つのエントリ。
コラボレーター と カスタム メッセージ — 署名ワークフローに添付されたコラボレーターレコードとメッセージ。
署名要求はすべての参加者を対象としたリストであるため、署名順序または状態を使用して、最初のエントリを想定するのではなく、気になる参加者を選択します。 Nitro Sign はイベントが到着する順序を保証しないため、シーケンスの権限として Occurred At (UTC) を扱います。
封筒が作成されると、 署名が完了し、 封筒 ID と名前のみが返されます。これらのイベントでは、ドキュメントや参加者の詳細は含まれません。 さらに必要な場合は、[ Id で封筒を取得 ] または [封筒 ID でドキュメントを一覧表示] を 使用します。
重要: 接続ごとに 1 つのアクティブなトリガー
Nitro Sign では現在、 クライアント ID ごとに 1 つの Webhook サブスクリプションが許可されています。 すべてのフローでクライアント ID と同じ接続共有が使用されるため、次を計画する必要があります。
Nitro Sign トリガーを使用してフローをオンにすると、同じ接続を使用する他の Nitro Sign トリガー フローが停止します。 最後に有効になったフローは、イベントを受信するフローです。
影響を受けるフローはPower Automateでオンのままになり、エラーは表示されません。単に発生を停止します。 2 つ以上のトリガーベースのフローを同時に実行する必要がある場合は、それぞれ別の Nitro クライアント ID で作成された独自の接続を付与します。 (トリガーではなく) アクションのみを使用するフローは影響を受けず、接続を自由に共有できます。
これは、一時的な Nitro Sign プラットフォームの制限です。 リフトされると、複数のトリガー フローで 1 つの接続を共有できるようになります。
フローをオフにする
フローをオフにすると、そのサブスクリプションが Nitro Sign 側に登録されたままになる場合があります。 その接続で次に Nitro Sign トリガー フローが有効になっている場合は、自動的にクリアされます。 その間、Nitro Sign はスイッチオフ フローのイベントを送信し続ける可能性があります。これらは破棄され、フローは実行されません。
現在の状態を確認する必要がある場合は、Nitro 開発者ポータルでアプリケーションの Webhook 構成を一覧表示します。
一般的な署名ワークフロー
完全な署名フローでは、上記のアクションが順番にチェーンされます。 一般的なPower Automate フローは次のようになります。
-
封筒の作成 — 名前、通知の件名/本文、署名モード (
parallelまたはsequential) を設定します。 返された エンベロープ ID を保存します。 -
封筒 ID でドキュメントを作成 する — 1 つ以上のファイルを封筒にアップロードします (手順 1 のエンベロープ ID を使用)。 返された各 ドキュメント ID を保存します。
(省略可能)封筒 ID によるドキュメントの並べ替え — ドキュメントの順序を設定します。 - エンベロープ ID による参加者の作成 - 署名者と CC 受信者をアクセス コード認証で追加します。 返された各 参加者 ID を保存します。
- ドキュメント ID によるフィールドの作成 — 各ドキュメントに署名/日付/などのフィールドを配置し、参加者に割り当てます (手順 2 のドキュメント ID と手順 3 の参加者 ID を使用)。
- 署名用封筒を送信 — 封筒を発送します。 すべてのドキュメントは、最初にアップロードされた状態である必要があります。
- (保留中)封筒のリマインダーを送信 して参加者を微調整するか、 ID で封筒をキャンセル して要求を停止します。
- (完了したら)シールされた封筒をダウンロード / IDでシールされたドキュメントをダウンロード / 完成したファイルを取得するために封筒の監査証跡をダウンロードします。
ヒント: 作成アクションによって返されるエンベロープ ID、ドキュメント ID、および参加者 ID は、Power Automateの動的コンテンツ ピッカーを使用して後のアクションに自然に送られ、入力するのではなくアップストリーム アクションから ID トークンを選択します。
イベント ドリブンのフォローアップ フロー
送信フロー内で待機するのではなく、別のフローで完了に対応できます。
- エンベロープがシールされると 、トリガーによってフローが開始され、 エンベロープ ID が提供されます。
- シールされた封筒をダウンロード する — トリガーの エンベロープ ID を 直接渡します。
- ファイルの作成 (OneDrive、SharePointなど) - ファイル名トークンとファイル コンテンツ トークンをファイル入力にドロップします。
同じパターンが機能するのは 、署名要求が拒否されて アラートが生成されたとき、または各参加者がパートを完了したときに進行状況の更新を投稿するために 署名要求が署名されたとき です。
エラーと調整
Nitro Sign API は、次のエラーを返す場合があります。
- 400 — 要求が正しくありません
- 401 — 未承認
- 404 — 見つかりません
- 409 - 競合 (操作を許可しない状態のエンベロープに対して動作する場合など)
- 413 - コンテンツが大きすぎます
- 415 — サポートされていないメディアの種類
- 422 — 処理不可能なエンティティ
- 500 — 内部サーバー エラー
スロットリング
- 接続あたりの API 呼び出し: 60 秒あたり 100。
プラットフォームの制限
ファイル サイズ
- 最大: 要求あたり 25 MB
単一ファイル操作とマルチファイル操作の両方に適用されます。
ページ数
- 最大: 個々のドキュメントあたり 250 ページ
複数のドキュメントの合計合計ページ数が 250 を超える場合があります。
保持時間
- 入力ファイルと出力ファイルは、操作完了後 約 15 分 後に削除されます。
Webhook サブスクリプション
- 最大: クライアント ID あたり 1 つのアクティブなサブスクリプション。 同時に実行する必要があるトリガー ベースのフローごとに、異なるクライアント ID で作成された個別の接続を使用します。
Notes
- エンベロープ、ドキュメント、フィールド、参加者の管理アクションは JSON を返します。
- ダウンロード アクションは、ファイル 名、ファイル コンテンツ タイプ、ファイル コンテンツ をピッカーネイティブ トークンとして公開する JSON エンベロープにラップされたファイル (ZIP または PDF) を返します。そのため、結果を式なしでダウンストリーム ファイル アクションに連結できます。
- 署名モード (
parallelとsequential) は、封筒の作成時に設定され、エンベロープの送信前に [エンベロープの更新] で変更できます。 - 参加者認証は現在、 アクセス コード のみをサポートしています。
- トリガーには構成は必要ありません。フローを有効にすると、Nitro Sign サブスクリプションが自動的に登録されます。 一度にアクティブにできるのは、接続ごとに 1 つのトリガー ベースのフローだけです。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有できません |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | 説明 | Required |
|---|---|---|---|
| Nitro クライアント ID | securestring | Nitro アプリケーションのクライアント ID | True |
| Nitro クライアント シークレット | securestring | Nitro アプリケーションのクライアント シークレット | True |
| Nitro リージョン | 文字列 | アカウントの Nitro API リージョンを選択します。 | True |
アクション
| ID でドキュメントを取得する |
Nitro Sign エンベロープ内の特定のドキュメントの詳細を取得します。 |
| ID でフィールドを更新する |
Nitro Sign ドキュメント内の既存のフィールドのプロパティを更新します。 フィールド型は指定する必要があり、既存のフィールド型と一致する必要があります。これは、フィールド スキーマを識別するために API によって使用され、フィールドの種類は変更されません。 |
| ID で封印されたドキュメントをダウンロードする |
1 つのシールされた署名付きドキュメントを、Pdf ファイルとして Nitro Sign エンベロープからダウンロードします。 |
| ID で封筒を削除する |
Nitro Sign エンベロープを完全に削除します。 この操作を元に戻すことはできません。また、関連付けられているすべてのドキュメント、フィールド、および参加者も削除されます。 |
| ID で封筒を取得する |
一意のエンベロープ ID を使用して、特定の Nitro Sign エンベロープの詳細を取得します。 |
| ID によるドキュメントの削除 |
Nitro Sign エンベロープからドキュメントを完全に削除します。 |
| ID によるドキュメントの更新 |
Nitro Sign エンベロープ内の既存のドキュメントのメタデータを更新します。 現在、更新できるのはドキュメント名のみです。 |
| ID によるフィールドの削除 |
Nitro Sign エンベロープ内のドキュメントからフィールドを完全に削除します。 |
| ID による参加者の削除 |
Nitro Sign エンベロープから参加者を完全に削除します。 |
| ID による参加者の更新 |
Nitro Sign エンベロープの参加者の認証設定を更新します。 参加者のメールを更新できません。 |
| ID による封筒の取り消し |
Nitro Sign エンベロープの署名要求をキャンセルします。 署名用に送信された封筒のみをキャンセルできます。 |
| エンベロープ ID で参加者を一覧表示する |
特定の Nitro Sign エンベロープに関連付けられているすべての参加者を取得します。 |
| エンベロープの更新 |
既存の Nitro Sign エンベロープを更新します。 エンベロープ名、通知設定、署名モード、またはこれらのフィールドの任意の組み合わせを変更できます。 |
| ドキュメント ID でフィールドを一覧表示する |
Nitro Sign エンベロープ内の特定のドキュメントに関連付けられているすべてのフィールドを取得します。 |
| ドキュメント ID でフィールドを作成する |
ドキュメントに 1 つ以上のフィールドを作成し、参加者に割り当てます。 1 つのフィールドを作成するには、Fields 配列に 1 つの項目を指定します。 複数のフィールドを作成するには、複数の項目を指定します。 |
| 元の封筒をダウンロードする |
Nitro Sign エンベロープから元の署名されていないドキュメントを ZIP アーカイブとしてダウンロードします。 |
| 封印された封筒をダウンロードする |
封印された署名済みドキュメントを、監査証跡と共に Nitro Sign エンベロープから ZIP アーカイブとしてダウンロードします。 |
| 封筒 ID でドキュメントを一覧表示する |
特定の Nitro Sign エンベロープに関連付けられているすべてのドキュメントを取得します。 |
| 封筒 ID でドキュメントを並べ替える |
指定されたドキュメント ID の一覧に基づいて、特定の Nitro Sign エンベロープに関連付けられているドキュメントを並べ替えます。 |
| 封筒 ID でドキュメントを作成する |
既存の Nitro Sign エンベロープにドキュメントをアップロードします。 ドキュメントは、後で署名ワークフローで使用できます。 |
| 封筒 ID で参加者を作成する |
1 つまたは複数の参加者を Nitro Sign エンベロープに追加します。 1 つの参加者を追加するには、Participants 配列に 1 つの項目を指定します。 複数の参加者を追加するには、複数の項目を指定します。 |
| 封筒のリマインダーを送信する |
指定された Nitro Sign エンベロープの保留中の参加者にアラーム通知をトリガーします。 通知設定が指定されていない場合は、エンベロープ用に構成された既定の通知テンプレートが使用されます。 |
| 封筒の監査証跡をダウンロードする |
選択した Nitro Sign エンベロープの完全な監査証跡を含む PDF ファイルをダウンロードします。 |
| 封筒を一覧表示する |
List Envelopes エンドポイントは、アカウント内のアプリケーションに関連付けられているすべてのエンベロープを返します。 |
| 封筒を作成する |
後でドキュメント、参加者、フィールドを設定し、署名のために送信できる新しい Nitro Sign エンベロープを作成します。 |
| 署名用封筒を送信する |
署名コレクションの参加者に Nitro Sign エンベロープを送信します。 このアクションを使用する前に、通常、封筒には、封筒 ID によるドキュメントの作成、封筒 ID による参加者の作成、ドキュメント ID によるフィールドの作成を使用して、ドキュメント、参加者、署名フィールドが追加されている必要があります。 封筒内のすべてのドキュメントは、封筒を送信する前にアップロード済みの状態である必要があります。 |
ID でドキュメントを取得する
Nitro Sign エンベロープ内の特定のドキュメントの詳細を取得します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
ドキュメントを含むエンベロープを識別する一意の UUID。 |
|
ドキュメント ID
|
documentID | True | uuid |
取得するドキュメントを識別する一意の UUID。 |
返品
Nitro Sign ドキュメントの詳細。
ID でフィールドを更新する
Nitro Sign ドキュメント内の既存のフィールドのプロパティを更新します。 フィールド型は指定する必要があり、既存のフィールド型と一致する必要があります。これは、フィールド スキーマを識別するために API によって使用され、フィールドの種類は変更されません。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
ドキュメントを含むエンベロープを識別する一意の UUID。 |
|
ドキュメント ID
|
documentID | True | uuid |
フィールドを含むドキュメントを識別する一意の UUID。 |
|
フィールド ID
|
fieldID | True | uuid |
更新するフィールドを識別する一意の UUID。 |
|
フィールドの型
|
type | True | string |
更新するフィールドの現在の型。 この値は API で必要であり、既存のフィールド型と一致する必要があります。フィールドの種類は変更されません。 |
|
参加者 ID
|
participantID | uuid |
フィールドに割り当てられている参加者の一意識別子。 |
|
|
ページ
|
page | integer |
フィールドが表示されるページ番号。 ページでは、1 から始まるインデックス作成が使用されます。 |
|
|
X 位置
|
x | float |
オプション。 ページの左端からポイント単位で測定されたフィールドの水平方向の位置。 |
|
|
Y 位置
|
y | float |
オプション。 ページの上端からポイント単位で測定されたフィールドの垂直方向の位置。 |
|
|
幅
|
width | float |
オプション。 フィールドの幅をポイント単位で指定します。 |
|
|
高さ
|
height | float |
オプション。 フィールドの高さ (ポイント単位)。 |
|
|
Required
|
required | boolean |
参加者がこのフィールドに入力する必要があるかどうかを示します。 |
|
|
フォーマット
|
format | string |
フィールド形式 (該当する場合)。 たとえば、日付フィールドには MM/DD/YYYY などの形式を使用できます。 |
|
|
変更可能
|
modifiable | boolean |
フィールド値が変更可能かどうかを示します (該当する場合)。 |
返品
Nitro Sign フィールドの詳細。
ID で封印されたドキュメントをダウンロードする
1 つのシールされた署名付きドキュメントを、Pdf ファイルとして Nitro Sign エンベロープからダウンロードします。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
シールされたドキュメントを含むエンベロープを識別する一意の UUID。 |
|
ドキュメント ID
|
documentID | True | uuid |
ダウンロードする封印されたドキュメントを識別する一意の UUID。 |
返品
JSON エンベロープとしてラップされたファイルをダウンロードしました。
ID で封筒を削除する
Nitro Sign エンベロープを完全に削除します。 この操作を元に戻すことはできません。また、関連付けられているすべてのドキュメント、フィールド、および参加者も削除されます。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
削除するエンベロープを識別する一意の UUID。 |
ID で封筒を取得する
一意のエンベロープ ID を使用して、特定の Nitro Sign エンベロープの詳細を取得します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
取得するエンベロープを識別する一意の UUID。 |
返品
Nitro Sign エンベロープが要求または作成された後に返される応答。
ID によるドキュメントの削除
Nitro Sign エンベロープからドキュメントを完全に削除します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
ドキュメントを含むエンベロープを識別する一意の UUID。 |
|
ドキュメント ID
|
documentID | True | uuid |
削除するドキュメントを識別する一意の UUID。 |
ID によるドキュメントの更新
Nitro Sign エンベロープ内の既存のドキュメントのメタデータを更新します。 現在、更新できるのはドキュメント名のみです。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
ドキュメントを含むエンベロープを識別する一意の UUID。 |
|
ドキュメント ID
|
documentID | True | uuid |
更新するドキュメントを識別する一意の UUID。 |
|
ドキュメント名
|
name | True | string |
ドキュメントの新しい名前。 |
返品
Nitro Sign ドキュメントの詳細。
ID によるフィールドの削除
Nitro Sign エンベロープ内のドキュメントからフィールドを完全に削除します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
ドキュメントを含むエンベロープを識別する一意の UUID。 |
|
ドキュメント ID
|
documentID | True | uuid |
フィールドを含むドキュメントを識別する一意の UUID。 |
|
フィールド ID
|
fieldID | True | uuid |
削除するフィールドを識別する一意の UUID。 |
ID による参加者の削除
Nitro Sign エンベロープから参加者を完全に削除します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
参加者を含むエンベロープを識別する一意の UUID。 |
|
参加者 ID
|
participantID | True | uuid |
削除する参加者を識別する一意の UUID。 |
ID による参加者の更新
Nitro Sign エンベロープの参加者の認証設定を更新します。 参加者のメールを更新できません。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
参加者を含むエンベロープを識別する一意の UUID。 |
|
参加者 ID
|
participantID | True | uuid |
更新する参加者を識別する一意の UUID。 |
|
認証の種類
|
type | string |
オプション。 参加者の認証方法を選択します。 指定した場合は、アクセス コードも指定する必要があります。 |
|
|
アクセス コード
|
accessCode | string |
認証の種類が指定されている場合にのみ必要です。 参加者認証が必要ない場合は、空白のままにします。 |
返品
Nitro Sign 参加者の詳細。
ID による封筒の取り消し
Nitro Sign エンベロープの署名要求をキャンセルします。 署名用に送信された封筒のみをキャンセルできます。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
キャンセルするエンベロープを識別する一意の UUID。 |
返品
Nitro Sign エンベロープが要求または作成された後に返される応答。
エンベロープ ID で参加者を一覧表示する
特定の Nitro Sign エンベロープに関連付けられているすべての参加者を取得します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
参加者を取得するエンベロープを識別する一意の UUID。 |
返品
Nitro Sign エンベロープに関連付けられている参加者を一覧表示したときに返される応答。
エンベロープの更新
既存の Nitro Sign エンベロープを更新します。 エンベロープ名、通知設定、署名モード、またはこれらのフィールドの任意の組み合わせを変更できます。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 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 |
署名順序を定義します。 並列を使用してすべての参加者に同時に通知するか、追加された順序で参加者に 1 つずつ通知する順番を使用します。 |
返品
Nitro Sign エンベロープが要求または作成された後に返される応答。
ドキュメント ID でフィールドを一覧表示する
Nitro Sign エンベロープ内の特定のドキュメントに関連付けられているすべてのフィールドを取得します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
ドキュメントを含むエンベロープを識別する一意の UUID。 |
|
ドキュメント ID
|
documentID | True | uuid |
フィールドを取得する必要があるドキュメントを識別する一意の UUID。 |
返品
1 つ以上のフィールドを作成した後に返される応答。
ドキュメント ID でフィールドを作成する
ドキュメントに 1 つ以上のフィールドを作成し、参加者に割り当てます。 1 つのフィールドを作成するには、Fields 配列に 1 つの項目を指定します。 複数のフィールドを作成するには、複数の項目を指定します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
エンベロープを識別する一意の UUID。 |
|
ドキュメント ID
|
documentID | True | uuid |
フィールドを作成する必要があるドキュメントを識別する一意の UUID。 |
|
参加者 ID
|
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 | string |
日付フィールドなど、書式設定をサポートするフィールド型の省略可能な書式。 例: MM/DD/YYYY。 |
|
|
変更可能
|
modifiable | boolean |
フィールドの種類でサポートされている参加者がフィールド値を変更できるかどうかを示します。 |
返品
1 つ以上のフィールドを作成した後に返される応答。
元の封筒をダウンロードする
Nitro Sign エンベロープから元の署名されていないドキュメントを ZIP アーカイブとしてダウンロードします。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
元のドキュメントをダウンロードするエンベロープを識別する一意の UUID。 |
返品
JSON エンベロープとしてラップされたファイルをダウンロードしました。
封印された封筒をダウンロードする
封印された署名済みドキュメントを、監査証跡と共に Nitro Sign エンベロープから ZIP アーカイブとしてダウンロードします。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
封印されたドキュメントをダウンロードする必要があるエンベロープを識別する一意の UUID。 |
返品
JSON エンベロープとしてラップされたファイルをダウンロードしました。
封筒 ID でドキュメントを一覧表示する
特定の Nitro Sign エンベロープに関連付けられているすべてのドキュメントを取得します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
ドキュメントを取得するエンベロープを識別する一意の UUID。 |
返品
Nitro Sign エンベロープに関連付けられているドキュメントを一覧表示するときに返される応答。
封筒 ID でドキュメントを並べ替える
指定されたドキュメント ID の一覧に基づいて、特定の Nitro Sign エンベロープに関連付けられているドキュメントを並べ替えます。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
ドキュメントの順序を変更するエンベロープを識別する一意の UUID。 |
|
ドキュメント ID
|
order | True | array of uuid |
封筒内のドキュメントの新しい順序を表すドキュメント ID の配列。 |
返品
Nitro Sign エンベロープに関連付けられているドキュメントを一覧表示するときに返される応答。
封筒 ID でドキュメントを作成する
既存の Nitro Sign エンベロープにドキュメントをアップロードします。 ドキュメントは、後で署名ワークフローで使用できます。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
ドキュメントがアップロードされるエンベロープを識別する一意の UUID。 |
|
ドキュメント名
|
documentName | True | string |
アップロードするドキュメントの名前。 この値は、Nitro に送信されるドキュメント メタデータをビルドするために使用されます。 |
|
コンテンツ タイプ
|
contentType | string |
アップロードされたドキュメントのコンテンツ タイプ。 PDF ファイルの場合は、アプリケーション/pdf を使用します。 メタデータから省略すると、PDF ファイルのみが受け入れられます。 |
|
|
ドキュメント ファイル
|
payload | True | file |
封筒にアップロードするドキュメント ファイル。 |
返品
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント ID
|
ID | uuid |
アップロードされたドキュメントを識別する一意の UUID。 |
|
ドキュメント名
|
name | string |
アップロードされたドキュメントの名前。 |
|
作成日時
|
createdAt | string |
ドキュメントが作成された日時を示すタイムスタンプ。 |
|
ドキュメントの状態
|
status | string |
アップロードされたドキュメントの処理状態。 |
封筒 ID で参加者を作成する
1 つまたは複数の参加者を Nitro Sign エンベロープに追加します。 1 つの参加者を追加するには、Participants 配列に 1 つの項目を指定します。 複数の参加者を追加するには、複数の項目を指定します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
参加者を追加するエンベロープを識別する一意の UUID。 |
|
Email
|
True |
参加者のメール アドレス。 |
||
|
Role
|
role | True | string |
参加者ロール。 署名者は、署名のためにフィールドを割り当てることができます。 CC 参加者は読み取り専用アクセス権を持っています。 |
|
認証の種類
|
type | string |
オプション。 参加者の認証方法を選択します。 指定した場合は、アクセス コードも指定する必要があります。 |
|
|
アクセス コード
|
accessCode | string |
認証の種類が指定されている場合にのみ必要です。 参加者認証が必要ない場合は、空白のままにします。 |
返品
1 人以上の参加者を作成した後に返される応答。
封筒のリマインダーを送信する
指定された Nitro Sign エンベロープの保留中の参加者にアラーム通知をトリガーします。 通知設定が指定されていない場合は、エンベロープ用に構成された既定の通知テンプレートが使用されます。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
アラーム通知を送信するエンベロープを識別する一意の UUID。 |
|
通知の件名
|
subject | string |
署名参加者に送信される電子メール通知の件名。 動的変数がサポートされています。たとえば、$(sender_name_or_email) が署名を要求しています。 |
|
|
通知本文
|
body | string |
署名参加者に送信される電子メール本文。 動的変数がサポートされています。たとえば、こんにちは、\n$(envelope_name)\nに署名してください、\n$(sender_name_or_email)。 |
封筒の監査証跡をダウンロードする
選択した Nitro Sign エンベロープの完全な監査証跡を含む PDF ファイルをダウンロードします。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
監査証跡をダウンロードする必要があるエンベロープを識別する一意の UUID。 |
返品
JSON エンベロープとしてラップされたファイルをダウンロードしました。
封筒を一覧表示する
List Envelopes エンドポイントは、アカウント内のアプリケーションに関連付けられているすべてのエンベロープを返します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページの後
|
pageAfter | string |
封筒の次のページを取得するために使用される省略可能なカーソル トークン。 前の応答によって返された nextPage 値を使用します。 |
|
|
前のページ
|
pageBefore | string |
封筒の前のページを取得するために使用される省略可能なカーソル トークン。 ページの後と一緒に使用しないでください。 |
返品
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
封筒
|
items | array of EnvelopeSummaryResponse |
封筒の一覧。 |
|
次のページから開始
|
nextPage | string |
封筒の次のページを取得するために Page After として使用できるカーソル トークン。 |
封筒を作成する
後でドキュメント、参加者、フィールドを設定し、署名のために送信できる新しい Nitro Sign エンベロープを作成します。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒名
|
name | True | string |
封筒の名前。 一意である必要はありません。 |
|
署名モード
|
mode | True | string |
署名順序を定義します。 並列を使用してすべての参加者に同時に通知するか、追加された順序で参加者に 1 つずつ通知する順番を使用します。 |
|
通知の件名
|
subject | True | string |
署名参加者に送信される電子メール通知の件名。 動的変数がサポートされています。たとえば、$(sender_name_or_email) が署名を要求しています。 |
|
通知本文
|
body | True | string |
署名参加者に送信される電子メール本文。 動的変数がサポートされています。たとえば、こんにちは、\n$(envelope_name)\nに署名してください、\n$(sender_name_or_email)。 |
返品
Nitro Sign エンベロープが要求または作成された後に返される応答。
署名用封筒を送信する
署名コレクションの参加者に Nitro Sign エンベロープを送信します。 このアクションを使用する前に、通常、封筒には、封筒 ID によるドキュメントの作成、封筒 ID による参加者の作成、ドキュメント ID によるフィールドの作成を使用して、ドキュメント、参加者、署名フィールドが追加されている必要があります。 封筒内のすべてのドキュメントは、封筒を送信する前にアップロード済みの状態である必要があります。
パラメーター
| Name | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
封筒 ID
|
envelopeID | True | uuid |
署名のために送信するエンベロープを識別する一意の UUID。 |
返品
Nitro Sign エンベロープに関する概要情報。
トリガー
| 封筒がシールされている場合 |
エンベロープがシールされていて、それ以上変更できない場合にトリガーされます。 |
| 封筒が作成されたとき |
新しい Nitro Sign エンベロープ (パッケージ) が作成されたときにトリガーされます。 |
| 封筒が取り消されたとき |
エンベロープが取り消されたときにトリガーされます。 |
| 封筒署名が完了したとき |
すべての参加者が署名し、シールが開始されたときにトリガーされます。 |
| 署名用に封筒が送信されたとき |
エンベロープが署名ワークフローに送信されたときにトリガーされます。 |
| 署名要求が拒否されたとき |
参加者が署名要求を拒否したときにトリガーされます。 |
| 署名要求が署名されたとき |
参加者が署名要求に署名するとトリガーされます。 |
封筒がシールされている場合
エンベロープがシールされていて、それ以上変更できない場合にトリガーされます。
返品
ライフサイクル イベント (EnvelopeCreated、EnvelopeSigningCompleted、EnvelopeSealed)。 ライブ ペイロードには data.package のみが含まれます。ドキュメントは常に空です。
封筒が作成されたとき
新しい Nitro Sign エンベロープ (パッケージ) が作成されたときにトリガーされます。
返品
ライフサイクル イベント (EnvelopeCreated、EnvelopeSigningCompleted、EnvelopeSealed)。 ライブ ペイロードには data.package のみが含まれます。ドキュメントは常に空です。
封筒が取り消されたとき
エンベロープが取り消されたときにトリガーされます。
返品
ワークフロー イベント (EnvelopeSentForSignature、SignatureRequestSigned、SignatureRequestDeclined、EnvelopeCancelled): data.package (full) + data.signingWorkflow。
封筒署名が完了したとき
すべての参加者が署名し、シールが開始されたときにトリガーされます。
返品
ライフサイクル イベント (EnvelopeCreated、EnvelopeSigningCompleted、EnvelopeSealed)。 ライブ ペイロードには data.package のみが含まれます。ドキュメントは常に空です。
署名用に封筒が送信されたとき
エンベロープが署名ワークフローに送信されたときにトリガーされます。
返品
ワークフロー イベント (EnvelopeSentForSignature、SignatureRequestSigned、SignatureRequestDeclined、EnvelopeCancelled): data.package (full) + data.signingWorkflow。
署名要求が拒否されたとき
参加者が署名要求を拒否したときにトリガーされます。
返品
ワークフロー イベント (EnvelopeSentForSignature、SignatureRequestSigned、SignatureRequestDeclined、EnvelopeCancelled): data.package (full) + data.signingWorkflow。
署名要求が署名されたとき
参加者が署名要求に署名するとトリガーされます。
返品
ワークフロー イベント (EnvelopeSentForSignature、SignatureRequestSigned、SignatureRequestDeclined、EnvelopeCancelled): data.package (full) + data.signingWorkflow。
定義
NitroSignEnvelopeEvent
ライフサイクル イベント (EnvelopeCreated、EnvelopeSigningCompleted、EnvelopeSealed)。 ライブ ペイロードには data.package のみが含まれます。ドキュメントは常に空です。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
イベントの種類
|
eventType | string | |
|
イベント ID
|
eventId | string | |
|
アカウント識別子
|
accountId | string | |
|
アプリケーション識別子
|
applicationId | string | |
|
Webhook 構成 ID
|
webhookConfigId | string | |
|
発生時刻 (UTC)
|
occurredAt | string | |
|
パッケージ
|
data.package | NitroSignPackageSummary |
ドキュメントを持ち運ばないイベントの封筒の概要。 |
NitroSignEnvelopeWorkflowEvent
ワークフロー イベント (EnvelopeSentForSignature、SignatureRequestSigned、SignatureRequestDeclined、EnvelopeCancelled): data.package (full) + data.signingWorkflow。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
イベントの種類
|
eventType | string | |
|
イベント ID
|
eventId | string | |
|
アカウント識別子
|
accountId | string | |
|
アプリケーション識別子
|
applicationId | string | |
|
Webhook 構成 ID
|
webhookConfigId | string | |
|
発生時刻 (UTC)
|
occurredAt | string | |
|
パッケージ
|
data.package | NitroSignPackage | |
|
signingWorkflow
|
data.signingWorkflow | NitroSignSigningWorkflow |
NitroSignPackageSummary
ドキュメントを持ち運ばないイベントの封筒の概要。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
封筒 ID
|
id | string | |
|
封筒名
|
name | string |
NitroSignPackage
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
封筒 ID
|
id | string | |
|
封筒名
|
name | string | |
|
ドキュメント
|
documents | array of NitroSignPackageDocument |
NitroSignPackageDocument
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント ID
|
id | string | |
|
ドキュメント名
|
name | string | |
|
ページ
|
pages | integer | |
|
ファイル サイズ (バイト)
|
fileSizeBytes | integer | |
|
起源
|
origin | string |
NitroSignSigner
コラボレーターの 'user' オブジェクト (同じ図形) にも使用されます。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
署名者の電子メール
|
string | ||
|
署名者名
|
firstName | string | |
|
署名者の姓
|
lastName | string |
NitroSignSignatureRequest
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
参加者 ID
|
participantId | string | |
|
署名者
|
signer | NitroSignSigner |
コラボレーターの 'user' オブジェクト (同じ図形) にも使用されます。 |
|
地位
|
status | string | |
|
署名順序
|
order | integer |
NitroSignCollaborator
[署名済み]/[拒否済み] で空の状態が確認されました。Cancelled には、空の participantId と collaborationType COLLABORATION_TYPE_UNKNOWNを含むレコードが表示されます。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
参加者 ID
|
participantId | string | |
|
ユーザー
|
user | NitroSignSigner |
コラボレーターの 'user' オブジェクト (同じ図形) にも使用されます。 |
|
コラボレーションの種類
|
collaborationType | string |
NitroSignSigningWorkflow
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
署名要求
|
signatureRequests | array of NitroSignSignatureRequest | |
|
コラボレーター
|
collaborators | array of NitroSignCollaborator | |
|
カスタム メッセージ
|
customMessage | string |
EnvelopeNotification
Nitro Sign エンベロープの通知メール設定。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
通知の件名
|
subject | string |
署名参加者に送信される電子メール通知の件名。 動的変数がサポートされています。たとえば、$(sender_name_or_email) が署名を要求しています。 |
|
通知本文
|
body | string |
署名参加者に送信される電子メール本文。 動的変数がサポートされています。たとえば、こんにちは、\n$(envelope_name)\nに署名してください、\n$(sender_name_or_email)。 |
EnvelopeSummaryResponse
Nitro Sign エンベロープに関する概要情報。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
封筒 ID
|
ID | uuid |
エンベロープを識別する一意の UUID。 |
|
作成日時
|
createdAt | date-time |
エンベロープが作成された日時を示す UTC タイムスタンプ。 |
|
最終更新日時
|
lastModifiedAt | date-time |
エンベロープが最後に変更された日時を示す UTC タイムスタンプ。 |
|
封筒名
|
name | string |
封筒の名前。 |
|
封筒の状態
|
status | string |
封筒の内部状態。 |
EnvelopeResponse
Nitro Sign エンベロープが要求または作成された後に返される応答。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
封筒 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 エンベロープに関連付けられているドキュメントを一覧表示するときに返される応答。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント
|
items | array of DocumentResponse |
封筒に関連付けられているドキュメントの一覧。 |
DocumentResponse
Nitro Sign ドキュメントの詳細。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント ID
|
ID | uuid |
ドキュメントを識別する一意の UUID。 |
|
ドキュメント名
|
name | string |
ドキュメントの名前。 |
|
作成日時
|
createdAt | date-time |
ドキュメントが作成された日時を示す UTC タイムスタンプ。 |
|
バイト単位のサイズ
|
sizeBytes | integer |
ドキュメント サイズ (バイト単位)。 |
|
ページ数
|
numPages | integer |
ドキュメント内のページ数。 |
|
ドキュメントの状態
|
status | string |
ドキュメントの現在の状態。 |
FieldsResponse
1 つ以上のフィールドを作成した後に返される応答。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
Fields
|
items | array of FieldResponse |
この要求で作成されたフィールド。 |
FieldResponse
Nitro Sign フィールドの詳細。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
フィールド ID
|
ID | uuid |
フィールドを識別する一意の UUID。 |
|
参加者 ID
|
participantID | uuid |
フィールドに割り当てられている参加者の一意識別子。 |
|
ドキュメント ID
|
documentID | uuid |
フィールドが属するドキュメントの一意識別子。 |
|
ページ
|
page | integer |
フィールドが表示されるページ番号。 |
|
境界ボックス
|
boundingBox | array of float |
[x,y, width, height]の 4 つの数値の配列をポイント単位で指定します。 |
|
Required
|
required | boolean |
参加者がこのフィールドに入力する必要があるかどうかを示します。 |
|
フィールドの型
|
type | string |
フィールドの型。 |
|
フォーマット
|
format | string |
フィールド形式 (該当する場合)。 |
|
変更可能
|
modifiable | boolean |
フィールド値が変更可能かどうかを示します (該当する場合)。 |
ParticipantsResponse
1 人以上の参加者を作成した後に返される応答。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
Participants
|
items | array of ParticipantResponse |
この要求で作成された参加者。 |
ParticipantsListResponse
Nitro Sign エンベロープに関連付けられている参加者を一覧表示したときに返される応答。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
Participants
|
items | array of ParticipantResponse |
封筒に関連付けられている参加者。 |
|
参加者の合計数
|
total | integer |
コレクションで使用可能な参加者の合計数。 |
ParticipantResponse
Nitro Sign 参加者の詳細。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
参加者 ID
|
ID | uuid |
参加者を識別する一意の UUID。 |
|
Email
|
参加者のメール アドレス。 |
||
|
Role
|
role | string |
参加者の役割。 |
|
認証
|
authentication | ParticipantAuthenticationResponse |
参加者に対して返される認証設定。 |
ParticipantAuthenticationResponse
参加者に対して返される認証設定。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
認証の種類
|
type | string |
参加者認証の種類。 |
|
アクセス コード
|
accessCode | string |
参加者用に構成されたアクセス コード。 |
FileDownloadResponse
JSON エンベロープとしてラップされたファイルをダウンロードしました。
| Name | パス | 型 | 説明 |
|---|---|---|---|
|
ファイル名
|
fileName | string |
ダウンロードしたファイルの名前。応答 Content-Disposition ヘッダーから派生します (例: result.zip または result.pdf)。 このトークンを、OneDriveやファイルの作成などのダウンストリーム アクションのファイル名入力SharePoint直接ドロップします。 |
|
ファイル コンテンツ タイプ
|
fileContentType | string |
ダウンロードしたファイルの MIME の種類 (application/zip、application/pdf など)。 |
|
ファイル コンテンツ
|
fileContent | byte |
base64 でエンコードされたファイルの内容。 このトークンは、ダウンストリーム アクションのファイル コンテンツ入力 (OneDriveや SharePoint ファイルの作成、または別の Nitro アクションなど) に直接ドロップします。式は必要ありません。 |