BlueInk (プレビュー)
Blueink コネクタを使用すると、Blueink の電子署名プラットフォームを自動化されたワークフローに追加できます。 コネクタを使用すると、バンドルのステータスの確認、新しいバンドルの作成、署名者情報へのアクセスなどを行うことができます。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Blueink のサポート |
| [URL] | https://help.blueink.com/en/ |
| メール | support@blueink.com |
| Connector Metadata | |
|---|---|
| 発行者 | Blueink |
| Web サイト | https://blueink.com |
| プライバシー ポリシー | https://blueink.com/privacy-policy/ |
| カテゴリー | ビジネス管理; 生産性 |
この汎用性の高いコネクタを使用すると、ユーザーはさまざまな Power Automate コネクタの機能を活用して、Blueink の強力な電子署名ソリューションをワークフローにシームレスに統合できます。 この統合により、ユーザーはドキュメント バンドルの作成と配布を簡単に自動化できるようになります。 このコネクタと他のコネクタとの調和のとれた相互作用を調整することで、ドキュメント管理プロセスを合理化し、効率を向上させ、クライアントや関係者にシームレスで効率的なドキュメント署名エクスペリエンスを保証することができます。 契約承認の自動化、法的文書の処理、その他のコンテキストでの事務処理など、このコネクタはワークフローを最適化し、生産性を向上させる強力なツールを提供します。
前提条件
このコネクタを使用するには、blueink.com からの API 対応アカウントが必要です。
資格情報の入手方法
アカウントを作成したら、ページの左側にある API ボタンをクリックします。 プライベート API キーでAPI キーの追加 ボタンを押します。 API キーにラベルを付けて、送信を押します。 再び表示されないため、API キーをコピーし、どこかに保存します。
コネクタの使用を開始する
初めて Blueink 接続を作成するときは、API キーの入力を求められます。 API キーは、常に トークン で始まり、その後にスペースが続き、作成した API キーが続く必要があります。 API キーを入力すると、この トークン のようになります。
一般的なアクションは、バンドルを作成することです。 バンドルを作成するには、複雑な入力セットが必要です。 body 変数がどのようなものになるかについては、https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle にある API ドキュメントを参照してください。 以下の画像は、バンドル作成本体の例です。
バンドルを作成するには複数の方法があり、作成するバンドルに合わせてこの JSON を変更できます。 この JSON を変更できるその他の方法については、API を参照してください。 これは、ユーザーがアカウントで設定した、前に作成したテンプレートを使用します。
完了したバンドルをすべてリストすることは、よく使用される別のエンドポイントです。 バンドルのリスト アクションを追加し、完了したバンドルのステータス ボタンを co に変更します。 このエンドポイントを使用すると、完了した最新のバンドルをすべて最新の状態に保つことができます。
既知の問題と制限事項
バンドル作成エンドポイントには本文 JSON が必要です
一般的なエラーと解決策
無効なトークン エラーで要求が成功しなかったというエラーが表示された場合は、API キーを貼り付けただけではなく、前の トークン 文字列の後にスペース、次に API キーを含めていないか確認してください。
バンドルの作成時に無効な入力に関するエラーが発生した場合は、Blueink に送信されている JSON が有効であることを確認してください。
よくあるご質問
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 Web サイトにアクセスするか、このコネクタに関連する Microsoft Power Automate ドキュメントを参照してください。
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 Power App が別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | Description | Required |
|---|---|---|---|
| Blueink API キー | securestring | Blueink API キー。 これは、Blueink の API タブで作成できます。正しい形式は 'Token XXXXXX' で、XXXXXX は API キーです | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| Webhook の一覧表示 |
BlueInk アカウントですべての Webhook を一覧表示する |
| Webhook の作成 |
新しい Webhook の作成 |
| Webhook の削除 |
ID で Webhook を削除する |
| Webhook の取得 |
ID で Webhook を取得する |
| Webhook の更新 |
新しいデータで Webhook を更新します。 この要求から省略されたサブスクリプションは削除されることに注意してください。 Webhook のすべてのデータを置き換えたくない場合は、代わりに PATCH を使用することをお勧めします。 |
| Webhook の部分的な更新 |
新しいデータで Webhook を部分的に更新します。 |
| Webhook 共有シークレットの再生成 |
Webhook 共有シークレットを再生成する |
| Webhook 共有シークレットの取得 |
Webhook 共有シークレットを取得する |
|
Webhook |
BlueInk アカウントですべての Webhook イベントを一覧表示する |
|
Webhook |
BlueInk アカウントですべての WebhookDeliveries を一覧表示する |
|
Webhook |
新しい Webhook ヘッダーの作成 |
|
Webhook |
WebhookExtraHeader の削除 |
|
Webhook |
WebhookExtraHeader の詳細を取得する |
|
Webhook |
新しいデータで WebhookExtraHeader を更新する |
|
Webhook |
新しいデータで WebhookExtraHeader を部分的に更新します。 |
|
Webhook |
BlueInk アカウントですべての WebhookExtraHeaders を一覧表示する |
| アラームの送信 |
署名者にアラーム メールまたは SMS を送信します。 アラームは 1 時間に 1 回のみ送信できます。 アラームは、配信方法 (メールまたは SMS) と、このパケットに事前に指定されたメール アドレス (または電話番号) に送信されます。 |
| エビデンスのパケット証明書の取得 |
このパケットのエビデンス証明書のリンクとチェックサムを取得する |
| ドキュメント テンプレートの一覧表示 |
すべてのドキュメント テンプレートを一覧表示する |
| ドキュメント テンプレートの取得 |
ドキュメント テンプレートの取得 |
| バンドル イベントを一覧表示 |
バンドルに関連付けられているイベントのリストを取得する |
| バンドル データの取得 |
完了したバンドルのフィールドに入力されたデータを取得する |
| バンドル ファイルの取得 |
完了したバンドルのダウンロード可能なファイルを取得する |
| バンドルからのタグの削除 |
バンドルからタグを削除します。 要求のタグがバンドルに存在しない場合、そのタグは無視されます。 |
| バンドルの一覧表示 |
アカウント内のバンドルのページ分割されたリストを、作成日順 (最新から最も古い順) に返します。 ページネーションは、ページネーション パラメーターによって制御できます (概要->ページネーションを参照)。
クエリ文字列フィルターのパラメーターは組み合わせることができます。例: |
| バンドルの取り消し |
バンドル スラグで指定されたバンドルを取り消す |
| バンドルの取得 |
置換フィールドでバンドルを取得する |
| バンドルへのタグの追加 |
バンドルに追加のタグを追加します。 バンドル上の既存のタグは削除されません。 この呼び出しの結果、Bundle.tags は、以前のタグのセットと新しいタグのセットを統合したものになります。 重複するタグは無視されます。 |
| バンドルを作成する |
署名用のバンドルを作成して送信する |
| パケットの更新 |
新しいメールアドレス、電話番号、名前、または認証オプションでパケット (別名、署名者) を更新します 更新されたパケットは、引き続き配信可能である必要があります。 たとえば、'phone' の 埋め込み署名用に当初構成されていた (つまり、deliver_via が 'embed' だった) パケットを、メールまたは SMS 経由で配信されるように変更できます。 ただし、署名通知やアラームは自動的に送信されません。 署名通知メール (または SMS) を送信するには、/packet/{packetId}/remind/ を呼び出す必要があります。 この署名者が個人に関連付けられている場合、その個人も更新されます。個人名が変更され (指定されている場合)、新しいメールアドレスまたは電話番号が追加されます。 |
| 個人の一覧表示 |
アカウントで個人の一覧を取得します。 オプションで、検索クエリを指定して一覧をフィルターできます。 たとえば、"John" という名前を持つすべての人物を検索するには、クエリ |
| 個人の作成 |
新しい個人を作成します。 個人は BlueInk ユーザーに関連付けることも、スタンドアロンの個人にすることもできます。 BlueInk ユーザーに関連付けられた個人を作成する場合は、 |
| 個人の削除 |
個人を削除します。 これにより、関連付けられた BlueInk ユーザーも削除されます。 |
| 個人の取得 |
ID により個人を取得する |
| 個人の更新 |
新しいデータで個人を更新します。 この要求から省略された連絡先チャネルは削除されることに注意してください。 個人のすべてのデータを置き換えたくない場合は、代わりに PATCH を使用することをお勧めします。 |
| 個人の部分的な更新 |
新しいデータで個人を部分的に更新します。 新しいメールアドレスまたは電話番号を個人に追加するには、'id' なしで 'channels' 配列にContactChannel を含めます。 個人に関連付けられた既存の ContactChannel を更新するには、'id' を含めます。 その既存の ContactChannel は、新しいメールアドレスまたは電話番号で更新されます。 これにより、そのメールアドレス (または電話番号) に送信している個人に関連付けられたライブ バンドルが更新されます。 ContactChannel に 'id' が含まれていないが、メールアドレス (または電話番号) が既存の ContactChannel と一致する場合、その ContactChannel は変更されません。 |
| 埋め込み署名 URL の作成 |
埋め込み署名に使用できる URL を作成する |
Webhook の一覧表示
BlueInk アカウントですべての Webhook を一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
有効化
|
enabled | boolean |
選択した '有効' ステータスに一致する Webhook のみが返されます。 E.g. |
|
|
イベント タイプ
|
event_type | string |
選択した event_type または event_types に一致する Webhook のみが返されます。 E.g. |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
enabled
|
enabled | boolean | |
|
event_types
|
event_types | array of string |
Webhook を起動するイベントの種類 |
|
extra_headers
|
extra_headers | array of object | |
|
id
|
extra_headers.id | uuid | |
|
名称
|
extra_headers.name | string |
RFC 7230 に準拠する必要あり |
|
注文
|
extra_headers.order | integer | |
|
価値
|
extra_headers.value | string |
RFC 7230 に準拠する必要あり |
|
Webhook
|
extra_headers.webhook | uuid | |
|
id
|
id | uuid | |
|
JSON
|
json | boolean | |
|
url
|
url | url |
http/https を含む完全な URL である必要あり |
Webhook の作成
新しい Webhook の作成
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
enabled
|
enabled | boolean | ||
|
event_types
|
event_types | array of string |
Webhook を起動するイベントの種類 |
|
|
id
|
id | uuid | ||
|
名称
|
name | string |
RFC 7230 に準拠する必要あり |
|
|
注文
|
order | integer | ||
|
価値
|
value | string |
RFC 7230 に準拠する必要あり |
|
|
Webhook
|
webhook | uuid | ||
|
id
|
id | uuid | ||
|
JSON
|
json | boolean | ||
|
url
|
url | url |
http/https を含む完全な URL である必要あり |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
event_types
|
event_types | array of string |
Webhook を起動するイベントの種類 |
|
extra_headers
|
extra_headers | array of object | |
|
id
|
extra_headers.id | uuid | |
|
名称
|
extra_headers.name | string |
RFC 7230 に準拠する必要あり |
|
注文
|
extra_headers.order | integer | |
|
価値
|
extra_headers.value | string |
RFC 7230 に準拠する必要あり |
|
Webhook
|
extra_headers.webhook | uuid | |
|
id
|
id | uuid | |
|
JSON
|
json | boolean | |
|
url
|
url | url |
http/https を含む完全な URL である必要あり |
Webhook の削除
ID で Webhook を削除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | uuid |
Webhook を一意に識別する ID |
Webhook の取得
ID で Webhook を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | uuid |
Webhook を一意に識別する ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
event_types
|
event_types | array of string |
Webhook を起動するイベントの種類 |
|
extra_headers
|
extra_headers | array of object | |
|
id
|
extra_headers.id | uuid | |
|
名称
|
extra_headers.name | string |
RFC 7230 に準拠する必要あり |
|
注文
|
extra_headers.order | integer | |
|
価値
|
extra_headers.value | string |
RFC 7230 に準拠する必要あり |
|
Webhook
|
extra_headers.webhook | uuid | |
|
id
|
id | uuid | |
|
JSON
|
json | boolean | |
|
url
|
url | url |
http/https を含む完全な URL である必要あり |
Webhook の更新
新しいデータで Webhook を更新します。 この要求から省略されたサブスクリプションは削除されることに注意してください。 Webhook のすべてのデータを置き換えたくない場合は、代わりに PATCH を使用することをお勧めします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | uuid |
Webhook を一意に識別する ID |
|
enabled
|
enabled | boolean | ||
|
event_types
|
event_types | array of string |
Webhook を起動するイベントの種類 |
|
|
id
|
id | uuid | ||
|
名称
|
name | string |
RFC 7230 に準拠する必要あり |
|
|
注文
|
order | integer | ||
|
価値
|
value | string |
RFC 7230 に準拠する必要あり |
|
|
Webhook
|
webhook | uuid | ||
|
id
|
id | uuid | ||
|
JSON
|
json | boolean | ||
|
url
|
url | url |
http/https を含む完全な URL である必要あり |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
event_types
|
event_types | array of string |
Webhook を起動するイベントの種類 |
|
extra_headers
|
extra_headers | array of object | |
|
id
|
extra_headers.id | uuid | |
|
名称
|
extra_headers.name | string |
RFC 7230 に準拠する必要あり |
|
注文
|
extra_headers.order | integer | |
|
価値
|
extra_headers.value | string |
RFC 7230 に準拠する必要あり |
|
Webhook
|
extra_headers.webhook | uuid | |
|
id
|
id | uuid | |
|
JSON
|
json | boolean | |
|
url
|
url | url |
http/https を含む完全な URL である必要あり |
Webhook の部分的な更新
新しいデータで Webhook を部分的に更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Webhook ID
|
webhookId | True | uuid |
Webhook を一意に識別する ID |
|
enabled
|
enabled | boolean | ||
|
event_types
|
event_types | array of string |
Webhook を起動するイベントの種類 |
|
|
id
|
id | uuid | ||
|
名称
|
name | string |
RFC 7230 に準拠する必要あり |
|
|
注文
|
order | integer | ||
|
価値
|
value | string |
RFC 7230 に準拠する必要あり |
|
|
Webhook
|
webhook | uuid | ||
|
id
|
id | uuid | ||
|
JSON
|
json | boolean | ||
|
url
|
url | url |
http/https を含む完全な URL である必要あり |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
enabled
|
enabled | boolean | |
|
event_types
|
event_types | array of string |
Webhook を起動するイベントの種類 |
|
extra_headers
|
extra_headers | array of object | |
|
id
|
extra_headers.id | uuid | |
|
名称
|
extra_headers.name | string |
RFC 7230 に準拠する必要あり |
|
注文
|
extra_headers.order | integer | |
|
価値
|
extra_headers.value | string |
RFC 7230 に準拠する必要あり |
|
Webhook
|
extra_headers.webhook | uuid | |
|
id
|
id | uuid | |
|
JSON
|
json | boolean | |
|
url
|
url | url |
http/https を含む完全な URL である必要あり |
Webhook 共有シークレットの再生成
Webhook 共有シークレットを再生成する
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
create_date
|
create_date | date-time | |
|
シークレット
|
secret | b58 |
Webhook 共有シークレットの取得
Webhook 共有シークレットを取得する
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
create_date
|
create_date | date-time | |
|
シークレット
|
secret | b58 |
WebhookEvents の一覧表示
BlueInk アカウントですべての Webhook イベントを一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Webhook ID
|
webhook | uuid |
選択した Webhook ID に一致する WebhookEvent のみが返されます。 E.g. |
|
|
イベント タイプ
|
event_type | string |
選択した event_type または event_types に一致する Webhook を持つ WebhookEvent のみが返されます。 E.g. |
|
|
Status
|
status | integer |
選択したステータスに一致する WebhookEvent のみが返されます。 E.g. |
|
|
成功結果
|
success | boolean |
選択した成功のステータスに一致する WebhookEvent のみが返されます。 E.g. |
|
|
期間
|
date | date-time |
期間内に発生した WebhookEvent のみが返されます。 注: 日付は YYYY-MM-DD 形式で表されます。 E.g. |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
created
|
created | date-time | |
|
配信
|
deliveries | array of object | |
|
message
|
deliveries.message | string |
問題を説明するメッセージ |
|
pk
|
deliveries.pk | uuid | |
|
ステータス
|
deliveries.status | integer |
応答のステータス メッセージ、またはステータスがない場合は 0 |
|
timestamp
|
deliveries.timestamp | date-time |
配信試行が発生したとき (タイムアウトなどの失敗時ではなく、試行の開始時) |
|
event_type
|
event_type | string | |
|
ペイロード
|
payload | string |
配信時に送信するペイロード; json |
|
pk
|
pk | uuid | |
|
ステータス
|
status | integer |
Webhook エンドポイントからの最後の応答のステータス コード。 0 は受信した応答がないことを示します |
|
成功
|
success | boolean | |
|
Webhook
|
webhook | uuid |
イベントがどの Webhook に属しているかを識別する UUID |
WebhookEvents の一覧表示
BlueInk アカウントですべての WebhookDeliveries を一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Webhook ID
|
webhook | uuid |
選択した Webhook ID に一致する WebhookDeliveries のみが返されます。 E.g. |
|
|
Webhook イベント ID
|
webhook_event | uuid |
選択した webhook_event ID に一致する WebhookDeliveries のみが返されます。 E.g. |
|
|
イベント タイプ
|
event_type | string |
選択した event_type または event_types に一致する Webhook を持つ WebhookDeliveries のみが返されます。 E.g. |
|
|
Status
|
status | integer |
選択したステータスに一致する WebhookDeliveries のみが返されます。 E.g. |
|
|
期間
|
date | date-time |
期間内に発生した WebhookDeliveries のみが返されます。 注: 日付は YYYY-MM-DD 形式で表されます。 E.g. |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
created
|
created | date-time | |
|
配信
|
deliveries | array of object | |
|
message
|
deliveries.message | string |
問題を説明するメッセージ |
|
pk
|
deliveries.pk | uuid | |
|
ステータス
|
deliveries.status | integer |
応答のステータス メッセージ、またはステータスがない場合は 0 |
|
timestamp
|
deliveries.timestamp | date-time |
配信試行が発生したとき (タイムアウトなどの失敗時ではなく、試行の開始時) |
|
event_type
|
event_type | string | |
|
ペイロード
|
payload | string |
配信時に送信するペイロード; json |
|
pk
|
pk | uuid | |
|
ステータス
|
status | integer |
Webhook エンドポイントからの最後の応答のステータス コード。 0 は受信した応答がないことを示します |
|
成功
|
success | boolean | |
|
Webhook
|
webhook | uuid |
イベントがどの Webhook に属しているかを識別する UUID |
WebhookExtraHeader の作成
新しい Webhook ヘッダーの作成
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
id
|
id | uuid | ||
|
名称
|
name | string |
RFC 7230 に準拠する必要あり |
|
|
注文
|
order | integer | ||
|
価値
|
value | string |
RFC 7230 に準拠する必要あり |
|
|
Webhook
|
webhook | uuid |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | uuid | |
|
名称
|
name | string |
RFC 7230 に準拠する必要あり |
|
注文
|
order | integer | |
|
価値
|
value | string |
RFC 7230 に準拠する必要あり |
|
Webhook
|
webhook | uuid |
WebhookExtraHeader の削除
WebhookExtraHeader の削除
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
WebhookExtraHeader ID
|
webhookExtraHeaderId | True | uuid |
WebhookExtraHeader を一意に識別する ID |
WebhookExtraHeader の取得
WebhookExtraHeader の詳細を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
WebhookExtraHeader ID
|
webhookExtraHeaderId | True | uuid |
WebhookExtraHeader を一意に識別する ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | uuid | |
|
名称
|
name | string |
RFC 7230 に準拠する必要あり |
|
注文
|
order | integer | |
|
価値
|
value | string |
RFC 7230 に準拠する必要あり |
|
Webhook
|
webhook | uuid |
WebhookExtraHeader の更新
新しいデータで WebhookExtraHeader を更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
WebhookExtraHeader ID
|
webhookExtraHeaderId | True | uuid |
WebhookExtraHeader を一意に識別する ID |
|
id
|
id | uuid | ||
|
名称
|
name | string |
RFC 7230 に準拠する必要あり |
|
|
注文
|
order | integer | ||
|
価値
|
value | string |
RFC 7230 に準拠する必要あり |
|
|
Webhook
|
webhook | uuid |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | uuid | |
|
名称
|
name | string |
RFC 7230 に準拠する必要あり |
|
注文
|
order | integer | |
|
価値
|
value | string |
RFC 7230 に準拠する必要あり |
|
Webhook
|
webhook | uuid |
WebhookExtraHeader の部分的な更新
新しいデータで WebhookExtraHeader を部分的に更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
WebhookExtraHeader ID
|
webhookExtraHeaderId | True | uuid |
WebhookExtraHeader を一意に識別する ID |
|
id
|
id | uuid | ||
|
名称
|
name | string |
RFC 7230 に準拠する必要あり |
|
|
注文
|
order | integer | ||
|
価値
|
value | string |
RFC 7230 に準拠する必要あり |
|
|
Webhook
|
webhook | uuid |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | uuid | |
|
名称
|
name | string |
RFC 7230 に準拠する必要あり |
|
注文
|
order | integer | |
|
価値
|
value | string |
RFC 7230 に準拠する必要あり |
|
Webhook
|
webhook | uuid |
WebhookExtraHeaders の一覧表示
BlueInk アカウントですべての WebhookExtraHeaders を一覧表示する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Webhook ID
|
webhook | uuid |
選択した Webhook ID に一致する WebhookExtraHeaders のみが返されます。 E.g. |
|
|
イベント タイプ
|
event_type | string |
選択した event_type または event_types に一致する Webhook を持つ WebhookExtraHeaders のみが返されます。 E.g. |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | uuid | |
|
名称
|
name | string |
RFC 7230 に準拠する必要あり |
|
注文
|
order | integer | |
|
価値
|
value | string |
RFC 7230 に準拠する必要あり |
|
Webhook
|
webhook | uuid |
アラームの送信
署名者にアラーム メールまたは SMS を送信します。 アラームは 1 時間に 1 回のみ送信できます。 アラームは、配信方法 (メールまたは SMS) と、このパケットに事前に指定されたメール アドレス (または電話番号) に送信されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
パケット スラグ
|
packetId | True | string |
パケットを一意に識別する置換フィールド |
戻り値
エビデンスのパケット証明書の取得
このパケットのエビデンス証明書のリンクとチェックサムを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
パケット スラグ
|
packetId | True | string |
パケットを一意に識別する置換フィールド |
戻り値
ドキュメント テンプレートの一覧表示
すべてのドキュメント テンプレートを一覧表示する
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
fields
|
fields | array of |
ドキュメント上に配置されたフィールドの配列。 DocumentTemplate フィールドは DocumentRequest フィールドとは少し異なり、 |
|
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
|
templateId | True | uuid |
テンプレートを一意に識別する ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
fields
|
fields | array of |
ドキュメント上に配置されたフィールドの配列。 DocumentTemplate フィールドは DocumentRequest フィールドとは少し異なり、 |
|
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 |
このロールに対するわかりやすいラベル |
バンドル イベントを一覧表示
バンドルに関連付けられているイベントのリストを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル スラグ
|
bundleSlug | True | string |
バンドルを一意に識別する置換フィールド |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
description
|
description | string |
イベントの簡単な説明 |
|
kind
|
kind | string |
2 文字コードでのイベントの種類 |
|
packet_id
|
packet_id | uuid |
パケットの UUID。 イベントが特定のパケットに関連付けられている場合にのみ存在します。 |
|
timestamp
|
timestamp | date-time |
イベントが発生した時刻 |
バンドル データの取得
完了したバンドルのフィールドに入力されたデータを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル スラグ
|
bundleSlug | True | string |
バンドルを一意に識別する置換フィールド |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
attachments
|
attachments | array of object |
添付ファイル フィールドの添付ファイルの配列、または null |
|
ext
|
attachments.ext | string |
ファイル拡張子 |
|
is_image
|
attachments.is_image | boolean |
この添付ファイルが画像の場合は true |
|
名称
|
attachments.name | string |
添付ファイルのファイル名 |
|
num
|
attachments.num | integer |
1 つの添付ファイル フィールドに対して複数のアップロードがある場合、ファイルが追加された順序 (たとえば、Web カメラで撮影したドキュメントの各ページの写真) |
|
size
|
attachments.size | integer |
ファイルのサイズ (バイト数) |
|
url
|
attachments.url | url |
添付ファイルのダウンロードに一時的に使用できる URL |
|
doc_key
|
doc_key | string |
バンドルでこのドキュメントを一意に識別するキー (元の BundleRequest から) |
|
field_key
|
field_key | string |
ドキュメント内のフィールドを一意に識別するキー (BundleRequest の DocumentRequest 内の元の DocumentRequestField で指定されたもの、または DocumentTemplate で構成されたもののいずれか) |
|
filled_by
|
filled_by | string |
このフィールドの値を入力した署名者のパケット キー。 フィールド値が署名者によって編集されていない 'initial_value' の場合、値は 'initial' です。 フィールド値が DocumentTemplate で構成されたデフォルト値であった場合、フィラーは 'default' になります。 |
|
kind
|
kind | string |
フィールドの種類 |
|
label
|
label | string |
フィールドのラベル (空白の場合あり) |
|
packet_id
|
packet_id |
このフィールドの値を入力した署名者のパケット ID。フィールド値が署名者によって入力されなかった (つまり、initial_value またはデフォルト値であった) 場合は null。 |
|
|
価値
|
value |
フィールドの値。 |
バンドル ファイルの取得
完了したバンドルのダウンロード可能なファイルを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル スラグ
|
bundleSlug | True | string |
バンドルを一意に識別する置換フィールド |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
有効期限
|
expires | string |
リンクの有効期限が切れる時刻 (ISO 8601 形式の時刻) |
|
file_url
|
file_url | string |
ファイルをダウンロードできる URL |
バンドルからのタグの削除
バンドルからタグを削除します。 要求のタグがバンドルに存在しない場合、そのタグは無視されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル スラグ
|
bundleSlug | True | string |
バンドルを一意に識別する置換フィールド |
|
tags
|
tags | array of string |
タグの配列 |
戻り値
バンドルの一覧表示
アカウント内のバンドルのページ分割されたリストを、作成日順 (最新から最も古い順) に返します。 ページネーションは、ページネーション パラメーターによって制御できます (概要->ページネーションを参照)。
クエリ文字列フィルターのパラメーターは組み合わせることができます。例: /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention。 フィルターを結合すると、すべてのフィルターに一致するバンドルのみが返されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索クエリ
|
search | string |
検索クエリ。 検索に一致するバンドルのみが返されます。 バンドルの以下のデータが検索されます:
E.g. |
|
|
バンドル ステータス
|
status | string |
指定したステータスを持つバンドルをに限定します。
E.g. |
|
|
バンドルのステータスの一覧
|
status__in | string |
指定したステータスのいずれかを持つバンドルをに限定します。 ステータスはコンマで区切る必要があります。
E.g. |
|
|
バンドル タグ
|
tag | string |
指定したタグを持つバンドルを返します。 E.g. |
|
|
バンドル タグの一覧
|
tag__in | string |
指定したタグの少なくとも 1 つを持つバンドルを返します。 タグはコンマで区切る必要があります。
E.g. |
|
|
バンドルの並べ替え順
|
ordering | string |
バンドルの並べ替え順を制御します。 並べ替え順を逆にするには、先頭に "-" を付けます。 デフォルトでは、バンドルは "-created"、つまりバンドルの作成日が新しいものから順に並べ替えられます。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of |
バンドルの取り消し
バンドル スラグで指定されたバンドルを取り消す
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル スラグ
|
bundleSlug | True | string |
バンドルを一意に識別する置換フィールド |
戻り値
バンドルの取得
置換フィールドでバンドルを取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル スラグ
|
bundleSlug | True | string |
バンドルを一意に識別する置換フィールド |
戻り値
バンドルへのタグの追加
バンドルに追加のタグを追加します。 バンドル上の既存のタグは削除されません。 この呼び出しの結果、Bundle.tags は、以前のタグのセットと新しいタグのセットを統合したものになります。 重複するタグは無視されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
バンドル スラグ
|
bundleSlug | True | string |
バンドルを一意に識別する置換フィールド |
|
tags
|
tags | array of string |
タグの配列 |
戻り値
バンドルを作成する
署名用のバンドルを作成して送信する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
body
|
body |
作成するバンドルを定義する JSON 本体 |
戻り値
パケットの更新
新しいメールアドレス、電話番号、名前、または認証オプションでパケット (別名、署名者) を更新します
更新されたパケットは、引き続き配信可能である必要があります。 たとえば、'phone' の deliver_via 値を指定したが、元の PacketRequest に電話番号が設定されていない場合、この要求には phone も含める必要があり、そうしないとエラーが返されます。
埋め込み署名用に当初構成されていた (つまり、deliver_via が 'embed' だった) パケットを、メールまたは SMS 経由で配信されるように変更できます。 ただし、署名通知やアラームは自動的に送信されません。 署名通知メール (または SMS) を送信するには、/packet/{packetId}/remind/ を呼び出す必要があります。
この署名者が個人に関連付けられている場合、その個人も更新されます。個人名が変更され (指定されている場合)、新しいメールアドレスまたは電話番号が追加されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
パケット スラグ
|
packetId | True | string |
パケットを一意に識別する置換フィールド |
|
body
|
body |
戻り値
個人の一覧表示
アカウントで個人の一覧を取得します。 オプションで、検索クエリを指定して一覧をフィルターできます。 たとえば、"John" という名前を持つすべての人物を検索するには、クエリ search=John を使用します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索クエリ
|
search | string |
検索クエリ。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
|
array of object | ||
|
channels
|
channels | array of object | |
|
メールアドレス
|
channels.email | ||
|
id
|
channels.id | uuid | |
|
kind
|
channels.kind | string |
メールは em。 電話は mp。 |
|
電話番号
|
channels.phone | phone | |
|
id
|
id | uuid | |
|
is_user
|
is_user | boolean |
この個人が BlueInk ユーザーに関連付けられている場合は True |
|
metadata
|
metadata | object |
この個人に関連付けるメタデータ。 SmartFill でメタデータを使用して、ドキュメントを自動的に入力できます。 詳細については、SmartFill ドキュメントを参照してください。 |
|
名称
|
name | string |
個人の名前 |
個人の作成
新しい個人を作成します。 個人は BlueInk ユーザーに関連付けることも、スタンドアロンの個人にすることもできます。 BlueInk ユーザーに関連付けられた個人を作成する場合は、user_id フィールドを指定する必要があります。 スタンドアロンの個人を作成する場合は、name フィールドを指定する必要があります。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
メールアドレス
|
||||
|
id
|
id | uuid | ||
|
kind
|
kind | string |
メールは em。 電話は mp。 |
|
|
電話番号
|
phone | phone | ||
|
id
|
id | uuid | ||
|
is_user
|
is_user | boolean |
この個人が BlueInk ユーザーに関連付けられている場合は True |
|
|
metadata
|
metadata | object |
この個人に関連付けるメタデータ。 SmartFill でメタデータを使用して、ドキュメントを自動的に入力できます。 詳細については、SmartFill ドキュメントを参照してください。 |
|
|
名称
|
name | string |
個人の名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
channels
|
channels | array of object | |
|
メールアドレス
|
channels.email | ||
|
id
|
channels.id | uuid | |
|
kind
|
channels.kind | string |
メールは em。 電話は mp。 |
|
電話番号
|
channels.phone | phone | |
|
id
|
id | uuid | |
|
is_user
|
is_user | boolean |
この個人が BlueInk ユーザーに関連付けられている場合は True |
|
metadata
|
metadata | object |
この個人に関連付けるメタデータ。 SmartFill でメタデータを使用して、ドキュメントを自動的に入力できます。 詳細については、SmartFill ドキュメントを参照してください。 |
|
名称
|
name | string |
個人の名前 |
個人の削除
個人を削除します。 これにより、関連付けられた BlueInk ユーザーも削除されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
personId | True | uuid |
個人を一意に識別する ID |
個人の取得
ID により個人を取得する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
personId | True | uuid |
個人を一意に識別する ID |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
channels
|
channels | array of object | |
|
メールアドレス
|
channels.email | ||
|
id
|
channels.id | uuid | |
|
kind
|
channels.kind | string |
メールは em。 電話は mp。 |
|
電話番号
|
channels.phone | phone | |
|
id
|
id | uuid | |
|
is_user
|
is_user | boolean |
この個人が BlueInk ユーザーに関連付けられている場合は True |
|
metadata
|
metadata | object |
この個人に関連付けるメタデータ。 SmartFill でメタデータを使用して、ドキュメントを自動的に入力できます。 詳細については、SmartFill ドキュメントを参照してください。 |
|
名称
|
name | string |
個人の名前 |
個人の更新
新しいデータで個人を更新します。 この要求から省略された連絡先チャネルは削除されることに注意してください。 個人のすべてのデータを置き換えたくない場合は、代わりに PATCH を使用することをお勧めします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
personId | True | uuid |
個人を一意に識別する ID |
|
メールアドレス
|
||||
|
id
|
id | uuid | ||
|
kind
|
kind | string |
メールは em。 電話は mp。 |
|
|
電話番号
|
phone | phone | ||
|
id
|
id | uuid | ||
|
is_user
|
is_user | boolean |
この個人が BlueInk ユーザーに関連付けられている場合は True |
|
|
metadata
|
metadata | object |
この個人に関連付けるメタデータ。 SmartFill でメタデータを使用して、ドキュメントを自動的に入力できます。 詳細については、SmartFill ドキュメントを参照してください。 |
|
|
名称
|
name | string |
個人の名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
channels
|
channels | array of object | |
|
メールアドレス
|
channels.email | ||
|
id
|
channels.id | uuid | |
|
kind
|
channels.kind | string |
メールは em。 電話は mp。 |
|
電話番号
|
channels.phone | phone | |
|
id
|
id | uuid | |
|
is_user
|
is_user | boolean |
この個人が BlueInk ユーザーに関連付けられている場合は True |
|
metadata
|
metadata | object |
この個人に関連付けるメタデータ。 SmartFill でメタデータを使用して、ドキュメントを自動的に入力できます。 詳細については、SmartFill ドキュメントを参照してください。 |
|
名称
|
name | string |
個人の名前 |
個人の部分的な更新
新しいデータで個人を部分的に更新します。
新しいメールアドレスまたは電話番号を個人に追加するには、'id' なしで 'channels' 配列にContactChannel を含めます。
個人に関連付けられた既存の ContactChannel を更新するには、'id' を含めます。 その既存の ContactChannel は、新しいメールアドレスまたは電話番号で更新されます。 これにより、そのメールアドレス (または電話番号) に送信している個人に関連付けられたライブ バンドルが更新されます。
ContactChannel に 'id' が含まれていないが、メールアドレス (または電話番号) が既存の ContactChannel と一致する場合、その ContactChannel は変更されません。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ユーザー ID
|
personId | True | uuid |
個人を一意に識別する ID |
|
メールアドレス
|
||||
|
id
|
id | uuid | ||
|
kind
|
kind | string |
メールは em。 電話は mp。 |
|
|
電話番号
|
phone | phone | ||
|
id
|
id | uuid | ||
|
is_user
|
is_user | boolean |
この個人が BlueInk ユーザーに関連付けられている場合は True |
|
|
metadata
|
metadata | object |
この個人に関連付けるメタデータ。 SmartFill でメタデータを使用して、ドキュメントを自動的に入力できます。 詳細については、SmartFill ドキュメントを参照してください。 |
|
|
名称
|
name | string |
個人の名前 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
channels
|
channels | array of object | |
|
メールアドレス
|
channels.email | ||
|
id
|
channels.id | uuid | |
|
kind
|
channels.kind | string |
メールは em。 電話は mp。 |
|
電話番号
|
channels.phone | phone | |
|
id
|
id | uuid | |
|
is_user
|
is_user | boolean |
この個人が BlueInk ユーザーに関連付けられている場合は True |
|
metadata
|
metadata | object |
この個人に関連付けるメタデータ。 SmartFill でメタデータを使用して、ドキュメントを自動的に入力できます。 詳細については、SmartFill ドキュメントを参照してください。 |
|
名称
|
name | string |
個人の名前 |
埋め込み署名 URL の作成
埋め込み署名に使用できる URL を作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
パケット スラグ
|
packetId | True | string |
パケットを一意に識別する置換フィールド |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
有効期限
|
expires | date-time |
URL の有効期限がいつ切れるかを示すタイムスタンプ |
|
url
|
url | string |
埋め込み署名に使用できる URL |