Peneo Sign Sandbox (プレビュー)
Peneo は、複雑なプロセスをシームレスで人間中心のエクスペリエンスに変換します。 Microsoft のプラットフォームでは、デジタル署名を自動化されたワークフローに統合することで、だれがどのようなデータをいつ承認したかを簡単に検証でき、管理上の負担を軽減しながら、完全なコンプライアンスとセキュリティを確保できます。 このコネクタを使用すると、署名用のドキュメントを送信できます。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | Regions |
|---|---|---|
| コピロット スタジオ | 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) |
| お問い合わせ | |
|---|---|
| 名前 | Peneo サポート |
| URL | https://www.support.penneo.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | Peneo の統合 |
| ソース | Swagger |
| Website | https://penneo.com |
| プライバシー ポリシー | https://penneo.com/privacy-policy |
| カテゴリ | 生産性 |
Peneo Sign Sandbox
Peneo は、複雑なプロセスをシームレスで人間中心のエクスペリエンスに変換します。 Microsoft のプラットフォームでは、デジタル署名を自動化されたワークフローに統合することで、だれがどのようなデータをいつ承認したかを簡単に検証でき、管理上の負担を軽減しながら、完全なコンプライアンスとセキュリティを確保できます。
Prerequisites
このコネクタを使用するには、アクティブな Peneo Sandbox アカウントが必要です。
サポートされているアクション
新しいケース ファイルを作成する
指定したドキュメントと署名者を使用して、Peneo に新しいケース ファイルを作成します。 ケース ファイルは Peneo で作成され、UUID と payloadHash が返されます。これは、キューの状態エンドポイントを介して作成状態を確認するために使用できます。
ジョブの状態の確認
ジョブ UUID と payloadHash を指定して、casefile の現在の状態を取得します。 このエンドポイントは、ケース ファイル作成要求を送信した後、ジョブの完了状態をポーリングするために使用されます。 エンドポイントは、uuid-payloadHash の組み合わせごとに 1 分あたり 20 件の要求にレート制限されます。
ケース ファイルの詳細を取得する
ケース ファイル ID に基づいて、Peneo から特定のケース ファイルの詳細を取得します。これには、署名者、ドキュメント、および現在の状態が含まれます。
ドキュメントのダウンロード
Peneo から base64 でエンコードされた文字列としてドキュメントの内容をダウンロードします。 既定では、署名されたバージョンのドキュメントが返されます。代わりに、 signed パラメーターを使用して署名されていないバージョンを取得します。 ケース ファイルにさらにドキュメントが含まれている場合は、各ドキュメントをループします。
資格情報の取得
コネクタは、承認コード付与で OAuth を使用するように構成されています。 ユーザーは、コネクタを使用するときに、通常の資格情報でログインする必要があります。
はじめに
ケース ファイルの作成
ドキュメントを準備する:
- PDF ドキュメントを base64 エンコードに変換する
- ドキュメントが有効な PDF ファイルであることを確認する
署名者の構成:
- 署名者の名前と電子メールを指定する (必須)
- 必要に応じて、ロール、言語、署名順序などを指定します。
- 必要に応じて、電子メール通知とカスタム電子メール テンプレートを構成する
ケース ファイルを作成します。
- [新しいケース ファイルの作成] アクションを使用する
- ケース ファイルの詳細を入力します。
- Title
- ドキュメント (base64 でエンコードされた PDF)
- 署名者 (名前とオプションの詳細を含む)
- オプションの設定 (有効期限、言語、可視性など)
CaseFile の作成状態を確認します。
- ケース ファイルを作成すると、UUID と payloadHash が表示されます
- "ジョブの状態の確認" アクションを使用してジョブの完了をポーリングする
- uuid ハッシュの組み合わせごとに 1 分あたり 20 要求のレート制限を尊重する
注: 各フィールドの動作は、 https://penneo.readme.io/reference/createcasefileチェックすることで確認できます。
ケース ファイルとそのドキュメントの取得
ケース ファイルの詳細を取得します。
- ケース ファイル ID で "ケース ファイルの詳細を取得する" アクションを使用する
- 応答には、ケース ファイルの状態、署名者、ドキュメントの一覧 (ドキュメント ID を含む) が含まれます
ドキュメントをダウンロードします。
- ケース ファイルの詳細から取得したドキュメント ID で "ドキュメントのダウンロード" アクションを使用する
- 応答には、base64 でエンコードされた文字列としてドキュメントの内容が含まれています。これをデコードして PDF ファイルを取得できます。
既知の問題と制限事項
レート制限: ジョブの状態の確認エンドポイントは、uuid ハッシュの組み合わせごとに 1 分あたり 20 件の要求にレート制限されます。 指数バックオフを使用して適切な再試行ロジックを実装します。
非同期処理: ケース ファイルの作成は非同期です。 ジョブの状態エンドポイントを使用して、即時の結果を期待するのではなく、完了を確認する必要があります。
Base64 エンコード: ドキュメントは base64 でエンコードする必要があります。 要求エラーを回避するために適切なエンコードを行います (Power Platform で base64 文字列関数を使用してバイナリ PDF ファイルをエンコードできます)。
サンドボックス環境: このコネクタは、Peneo サンドボックス環境 (
sandbox.penneo.com) 用に構成されています。ドキュメント サイズ: 大きなドキュメントの処理に時間がかかる場合があります。 base64 にエンコードする場合は、ドキュメント サイズの制限を検討してください。
デプロイ手順
次のコマンドを実行し、プロンプトに従います。
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --icon icon.png --script script.csx
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| ケース ファイルの詳細を取得する |
Peneo から、署名者、ドキュメント、現在の状態など、特定のケース ファイルの詳細を取得します。 ケース ファイルの状態: 0=new、1=pending、2=rejected、3=deleted、4=signed、5=completed、6=failed、7=expired、8=匿名化。 署名済みドキュメントをダウンロードするためのトリガーとして、状態 5 (完了) を使用します。 |
| ジョブの状態の確認 |
ジョブ UUID と payloadHash を指定して、非同期ジョブの現在の状態を取得します。 このエンドポイントは、ケース ファイル作成要求を送信した後、ジョブの完了状態をポーリングするために使用されます。 このアクションは、uuid-payloadHash の組み合わせごとに 1 分あたり 20 件の要求にレート制限されます。 |
| ドキュメントのダウンロード |
Peneo から base64 でエンコードされた文字列としてドキュメントの内容をダウンロードします。 既定では、署名されたバージョンのドキュメントが返されます。 |
| 新しいケース ファイルを作成する |
指定したドキュメントと署名者を使用して、Peneo に新しいケース ファイルを作成します。 ケース ファイルは非同期的に作成され、ジョブ UUID と payloadHash が返されます。これは、ジョブの状態の確認アクションを使用して作成状態を確認するために使用できます。 署名者、ドキュメント、署名順序、電子メール通知、アクセス制御、およびその他のさまざまなケース ファイル設定を構成できます。 |
ケース ファイルの詳細を取得する
Peneo から、署名者、ドキュメント、現在の状態など、特定のケース ファイルの詳細を取得します。 ケース ファイルの状態: 0=new、1=pending、2=rejected、3=deleted、4=signed、5=completed、6=failed、7=expired、8=匿名化。 署名済みドキュメントをダウンロードするためのトリガーとして、状態 5 (完了) を使用します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ケース ファイル ID
|
caseFileId | True | integer |
取得するケース ファイルの ID。 "ジョブの状態の確認" アクションを使用してケース ファイル ID を取得します。 |
返品
Peneo セキュア アーカイブから取得されたケース ファイルの詳細。
- Body
- CaseFileDetails
ジョブの状態の確認
ジョブ UUID と payloadHash を指定して、非同期ジョブの現在の状態を取得します。 このエンドポイントは、ケース ファイル作成要求を送信した後、ジョブの完了状態をポーリングするために使用されます。 このアクションは、uuid-payloadHash の組み合わせごとに 1 分あたり 20 件の要求にレート制限されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
uuid
|
uuid | True | uuid |
確認するジョブの UUID。 これは、ジョブの作成時に返されます。 |
|
payloadHash
|
payloadHash | True | string |
ペイロードの SHA-256 ハッシュ。 これは、ジョブの作成時に返され、要求の信頼性を確認するために使用されます。 |
返品
- Body
- QueueJob
ドキュメントのダウンロード
Peneo から base64 でエンコードされた文字列としてドキュメントの内容をダウンロードします。 既定では、署名されたバージョンのドキュメントが返されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ドキュメント ID
|
documentId | True | integer |
ダウンロードするドキュメントの ID。 "ケース ファイルの詳細の取得" アクションを使用して documentId を取得します。 |
|
Signed
|
signed | boolean |
署名されたドキュメントまたは署名されていないドキュメントを取得します。 既定では、ドキュメントが署名されている場合は、署名されたドキュメントが返されます。 |
返品
- Body
- DocumentContent
新しいケース ファイルを作成する
指定したドキュメントと署名者を使用して、Peneo に新しいケース ファイルを作成します。 ケース ファイルは非同期的に作成され、ジョブ UUID と payloadHash が返されます。これは、ジョブの状態の確認アクションを使用して作成状態を確認するために使用できます。 署名者、ドキュメント、署名順序、電子メール通知、アクセス制御、およびその他のさまざまなケース ファイル設定を構成できます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
タイトル
|
title | True | string |
ケース ファイルのタイトル。 |
|
sendAt
|
sendAt | integer |
ケース ファイルを送信する必要があるタイムスタンプ。 Null = すぐに |
|
|
name
|
name | True | string |
署名者の名前 |
|
ロール
|
role | string |
署名者のロール。 使用できる文字、数字、スペース、コンマ、アンダースコア、ハイフン。 文字/数字で始まる必要があり、スペースで終わる必要はありません。 |
|
|
メール
|
署名者の電子メール。 Peneo は、すべての通信を処理します |
|||
|
failUrl
|
failUrl | uri |
失敗後のリダイレクト URL |
|
|
言語
|
language | string |
署名者の言語 |
|
|
emailText
|
emailText | string |
署名要求メールのカスタム テキスト。 指定しない場合は、既定で会社のテンプレートが使用されます。 |
|
|
signOrder
|
signOrder | integer |
署名順序。 0 は、強制順序がないことを意味します。 |
|
|
successUrl
|
successUrl | uri |
成功後のリダイレクト URL |
|
|
emailSubject
|
emailSubject | string |
署名要求メールの件名。 指定しない場合は、既定で会社のテンプレートが使用されます。 |
|
|
reminderInterval
|
reminderInterval | integer |
アラームが送信されるまでの日数 |
|
|
reminderEmailText
|
reminderEmailText | string |
アラーム メールのカスタム テキスト。 指定しない場合は、既定で会社のテンプレートが使用されます。 |
|
|
completedEmailText
|
completedEmailText | string |
完了したメールのカスタム テキスト。 指定しない場合は、既定で会社のテンプレートが使用されます。 |
|
|
reminderEmailSubject
|
reminderEmailSubject | string |
アラームメールの件名。 指定しない場合は、既定で会社のテンプレートが使用されます。 |
|
|
completedEmailSubject
|
completedEmailSubject | string |
完了したメールの件名。 指定しない場合は、既定で会社のテンプレートが使用されます。 |
|
|
enableInsecureSigning
|
enableInsecureSigning | boolean |
true の場合、署名者はタッチ署名 (描画、テキスト、画像のアップロード) を使用できます |
|
|
insecureSigningMethods
|
insecureSigningMethods | array of string |
許可されている安全でない署名方法。 既定値は、空の場合は会社の設定です。 |
|
|
secureSigningMethods
|
secureSigningMethods | array of string |
許可されているセキュリティで保護された電子署名方法。 設定時にケース ファイルと顧客設定をオーバーライドします。 |
|
|
vatin
|
vatin | string |
署名者の会社の VAT 識別番号 |
|
|
ssnType
|
ssnType | string |
SSN/mobile の種類。 例 :'dk:cpr'、'se:pin'、'no:nin'、'be:nrn'、'fi:pic'、または 'sms'。 既定値は 'legacy' です |
|
|
activeAt
|
activeAt | integer |
アクティブ化のタイムスタンプ |
|
|
expireAt
|
expireAt | integer |
有効期限のタイムスタンプ |
|
|
アクセス制御
|
accessControl | boolean |
有効にすると、アクセス前に SSN/VATIN/phone が検証されます |
|
|
emailFormat
|
emailFormat | string |
電子メール形式を定義します |
|
|
onBehalfOf
|
onBehalfOf | string |
この署名者が代理で署名する会社/組織 |
|
|
storeAsContact
|
storeAsContact | boolean |
true の場合、署名者は Peneo に連絡先として保存されます |
|
|
socialSecurityNumberPlain
|
socialSecurityNumberPlain | string |
署名者の SSN または電話番号 (E.164 形式を推奨) |
|
|
expireAt
|
expireAt | integer |
ケース ファイルの有効期限が切れるタイムスタンプ。 指定しない場合は、既定値が適用されます |
|
|
言語
|
language | string |
ケース ファイルの言語は、言語が設定されていないすべての署名者に適用されます |
|
|
Pdf
|
True | string |
Base64 でエンコードされた PDF |
|
|
signable
|
signable | boolean |
True は署名可能なドキュメントを作成します。 False の場合、ドキュメントは添付ファイルとして追加され、署名できません。 |
|
|
roles
|
roles | array of string |
署名者ロールは、このドキュメントに署名できます。 既定値は、空の場合、すべての署名者です。 |
|
|
タイトル
|
title | True | string |
ドキュメントのタイトル |
|
documentOrder
|
documentOrder | integer |
ドキュメントの署名順序。 既定値は order provided です。 |
|
|
メタデータ
|
metaData | string |
ドキュメントのメタデータ (Peneo で検索可能) |
|
|
sensitiveData
|
sensitiveData | boolean |
true の場合、署名者はドキュメントにアクセスする前に ID を検証する必要があります。 署名済みドキュメントの電子メールの添付ファイルを無効にします。 |
|
|
signOnMeeting
|
signOnMeeting | boolean |
会議中にドキュメントに署名するかどうかを指定します。 |
|
|
visibilityMode
|
visibilityMode | integer |
0 = 署名者はすべてのドキュメントを表示します。 1 = 署名者には、署名する必要があるドキュメントのみが表示されます。 |
|
|
disableEmailAttachments
|
disableEmailAttachments | boolean |
最終処理メールの署名済みドキュメントの電子メールの添付ファイルを無効にします。 sensitiveData が true の場合にオーバーライドされます。 |
|
|
disableNotificationsOwner
|
disableNotificationsOwner | boolean |
true の場合、ケース ファイルの所有者はケース ファイルの通知を受け取りません。 |
|
|
folderId
|
folderId | integer |
casefile を配置するフォルダー ID |
|
|
メタデータ
|
metaData | string |
ケース ファイルのメタデータ(Peneo で検索可能) |
|
|
参照
|
reference | string |
ケース ファイルの参照は、Peneo Web アプリケーションに表示されます |
|
|
name
|
name | True | string |
受信者の名前 |
|
メール
|
True |
受信者の電子メール |
返品
- Body
- JobResponse
定義
JobResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
jobs
|
jobs | array of Job |
作成されたジョブの配列 (通常は 1 つのジョブが含まれます) |
|
状態
|
status | string |
ジョブ作成要求の状態 |
|
メッセージ
|
message | string |
ジョブの作成に関する人間が判読できるメッセージ |
Job
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
uuid
|
uuid | uuid |
状態の確認に使用できるジョブの一意の識別子 |
|
uuid
|
payload.uuid | uuid |
作成されたケース ファイルの UUID |
|
bundleUuid
|
payload.bundleUuid | uuid |
ケース ファイルを含むバンドルの UUID |
|
etlVersionUuid
|
payload.etlVersionUuid | uuid |
処理に使用される ETL バージョンの UUID |
|
organizationUuid
|
payload.organizationUuid | uuid |
このケース ファイルを所有する組織の UUID |
|
customData
|
payload.customData | object |
ジョブの追加のメタデータとコンテキスト |
|
createdAt
|
createdAt | date-time |
ジョブの作成時の ISO 8601 タイムスタンプ |
|
payloadHash
|
payloadHash | string |
ジョブの状態を確認するときに検証に使用されるペイロードの SHA-256 ハッシュ |
QueueJob
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
型
|
type | string |
キュー ジョブの種類 (例: "casefile_creation") |
|
uuid
|
uuid | uuid |
ジョブの一意識別子 |
|
結果
|
result | object |
キュー ジョブの実行の結果。ジョブの完了時に JSON として返されます。 結果と関連するデータが含まれます。 |
|
jobStatus
|
jobStatus | string |
ジョブの現在の状態です。 指定できる値は、'pending' (処理待ち)、'processing' (現在実行中)、'completed' (正常に完了)、'failed' (実行失敗)、'aborted_duplicated' (重複により中止) |
|
ペイロード
|
payload | object |
ジョブと共に送信された元のペイロード。JSON として格納されます。 ケース ファイルのデータとメタデータを格納します。 |
|
再試行
|
retries | integer |
失敗後にジョブが再試行された回数 |
|
createdAt
|
createdAt | date-time |
キュー ジョブが作成された日時 |
|
updatedAt
|
updatedAt | date-time |
キュー ジョブが最後に更新された日時 |
|
maxRetries
|
maxRetries | integer |
このジョブが失敗としてマークされるまでに許容される再試行の最大数 |
|
payloadHash
|
payloadHash | string |
検証とセキュリティの目的で使用されるペイロードの SHA-256 ハッシュ |
|
errorMessage
|
errorMessage | string |
ジョブが失敗した理由を説明するエラー メッセージ (該当する場合)。 jobStatus が 'failed' の場合にのみ存在します。 |
CcRecipient
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
name
|
name | string |
受信者の名前 |
|
メール
|
受信者の電子メール |
CaseFileDetails
Peneo セキュア アーカイブから取得されたケース ファイルの詳細。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザーID
|
userId | integer |
ケース ファイルを所有するユーザーの ID。 |
|
customerId
|
customerId | integer |
ケース ファイルが属している顧客の ID。 |
|
署名
|
signers | array of SignerDetails |
ケース ファイルの署名者の一覧。 |
|
識別子
|
id | integer |
ケース ファイル ID。 |
|
タイトル
|
title | string |
ケース ファイルのタイトル。 |
|
状態
|
status | integer |
ケース ファイルの状態。 |
|
ドキュメント
|
documents | array of DocumentDetails |
ケース ファイル内のドキュメントの一覧。 |
|
expireAt
|
expireAt | integer |
ケース ファイルの有効期限が切れたときの UNIX タイムスタンプ。 |
|
ccRecipients
|
ccRecipients | array of CcRecipient |
署名済みドキュメントのコピーを受け取る CC 受信者の一覧。 |
|
created
|
created | integer |
ケース ファイルが作成されたときの UNIX タイムスタンプ。 |
|
アクティブ化済み
|
activated | integer |
ケース ファイルがアクティブ化されたときの UNIX タイムスタンプ。 |
|
更新
|
updated | integer |
ケース ファイルが最後に更新されたときの UNIX タイムスタンプ。 |
|
完了
|
completed | integer |
ケース ファイルが完了したときの UNIX タイムスタンプ。 |
SignerDetails
ケース ファイルの署名者。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
name
|
name | string |
署名者の名前。 |
|
識別子
|
id | integer |
署名者 ID。 |
|
signingRequest
|
signingRequest | SigningRequestDetails |
署名者に関連付けられている署名要求。 |
SigningRequestDetails
署名者に関連付けられている署名要求。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer |
署名要求 ID。 |
|
メール
|
string |
署名者の電子メール。 |
|
|
状態
|
status | integer |
署名要求の状態。 |
DocumentDetails
ケース ファイル内のドキュメント。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
識別子
|
id | integer |
ドキュメント ID。これを使用して、"ドキュメントのダウンロード" アクションでドキュメントをダウンロードします。 |
|
状態
|
status | integer |
ドキュメントの状態。 |
|
signable
|
signable | boolean |
True の 場合は、ドキュメントが署名可能です。 |
DocumentContent
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ドキュメント コンテンツ
|
content | byte |
ドキュメントの Base64 でエンコードされたコンテンツ。 |