PKIsigning (プレビュー)

PKIsigning プラットフォーム コネクタで、ドキュメント署名のニーズを自動化します。 ドキュメントを PKIsigning プラットフォームに送信し、招待状を送信して、署名されたドキュメントを取得します。

このコネクタは、次の製品および地域で利用可能です:

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)
お問い合わせ先
件名 PKIsigning support
[URL] https://pkisigning.nl/support
メール support@pkisigning.nl
Connector Metadata
発行者 SBRS B.V.
Web サイト https://pkisigning.nl
プライバシー ポリシー https://pkisigning.nl/privacy
カテゴリー コラボレーション、生産性

PKIsigning を使用すると、組織はドキュメントの承認、署名、および顧客やサード パーティへの送信のプロセスを自動化、簡素化、およびセキュリティ保護できます。 プラットフォームは、オランダの適格トラステッド サービス プロバイダーからのすべての eIDAS 個人署名証明書をサポートし、ISO27001 認定を受けています。 このため PKIsigning は、法律、金融、医療機関および政府にとって理想的なパートナーです。 PKisigning と接続して、ドキュメントの署名プロセスを自動化、簡素化、およびセキュリティ保護します。

前提条件

PKIsigning コネクタを使用するには、"professional" サブスクリプション内に PKIsigning プラットフォームへのアカウントが必要です。 有料サブスクリプションの登録については、PKIsigning にお問い合わせ ください。

資格情報の入手方法

サブスクリプションに登録すると、ユーザーには、アカウントを設定するための招待メールが送信されます。 登録後、そのアカウントはこのコネクタで直接使用できます。

コネクタの使用を開始する

ドキュメントへの署名を開始するデフォルトのフローは次のとおりです:

  1. 書類を作成
  2. ドキュメントの追加
  3. アクターを追加
  4. ワークフローの開始
  5. トリガーを使用したステータスの変更の通知
  6. 書類をダウンロード

書類

PKIsigning では、必ず最初に書類を作成することを想定しています。 書類は、ドキュメントとアクターのコンテナーとして機能します。 書類は Dossiers_Create アクションで作成できます。 書類が作成されたら、返された PkisId を今後のアクションの参照として使用してください。

Documents

書類が作成された後、正しい dossierId を使用して Documents_Add アクションでドキュメントを追加できます。 アクションでは、ドキュメント ファイル自体から取得されるため、他のパラメーターは必要ありません。 書類内のドキュメントの数に制限はありません。 追加されたすべてのアクターについて、すべてのドキュメントが表示およびダウンロード可能になります。

重要: ドキュメントには、署名の数に応じて、1 つ以上の固有のテキスト プレースホルダーが必要で、署名を配置する必要がある場所と、どのアクターによるものかを示します。 これは、ドキュメント内の任意の場所にある任意のテキストにすることができます。 アクターを追加するときは、プレースホルダー パラメーターを使用してプレースホルダーを定義できます。 例: signature1、signature2 など...

当事者

3 番目のステップでは、アクターをドキュメントに追加します。 これは、正しい dossierId と documentId を使用して Actor_Create アクションで行われます。

ワークフローの開始

ワークフローを開始し、指定された順序でドキュメントに署名またはダウンロードするようにすべてのアクターに招待状を効果的に送信するには、正しい dossierId で Dossiers_StartWorkflow アクションを使用します。

トリガーを使用したステータスの変更の通知

署名後にドキュメントを取得するには、トリガーを使用して通知を購読します。 ステータス通知を受け取るには、イベント フィールドに 'status' を指定します。

書類をダウンロード

ステータスの更新がトリガーに通知されたら、ドキュメントのステータスが 'Completed' であるかどうかを確認します。 その時点で、書類内のすべてのドキュメントを 1 つの zipfile でダウンロードすることが可能です。 audittrail を生成するように PKIsigning プラットフォーム内の設定で指定されている場合、これも含まれます。

既知の問題と制限事項

公開時点で、既知の問題はありません。

一般的なエラーと解決策

トリガーによるステータス更新なし

トリガーがステータス更新に応答しない場合は、イベント フィールドに値 'status' が指定されているかどうかを確認してください。

HTTP エラー 402 支払いが必要

PKIsigning プラットフォームでは、アクションを実行するためにクレジットが必要でした。 アクターを追加すると、アクションを実行できるようにクレジットが予約され、招待者は利用可能なクレジットの数が不十分であるという問題に直面しません。 多数の招待がアクターに送信されると、クレジット バンドルには予約するクレジットが残っていない可能性があります。 その時点で、HTTP 402 エラーが返されます。

この問題を解決するには、PKIsigning サポート を利用してクレジット残高を補充するか、プラットフォームの recyclebin にあるアクター付きの未送信書類をクリーンアップします。 未使用のクレジットは再び利用可能になります。

よくあるご質問

knowledgebase を参照するか、support@pkisigning.nlまでお問い合わせください

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

アクター データの取得

特定のアクターのすべてのデータを返します。

アクターの作成

新しいアクターを作成し、ドキュメントに追加します。

アクターの削除

特定のアクターを完全に削除します。

アクターの更新

特定のアクターのデータを変更します。

ドキュメント データの取得

特定のドキュメントのすべての (メタ) データを返します。

ドキュメントによるアクター データの取得

特定のドキュメントのすべてのアクターのすべてのデータを返します。

ドキュメントの作成

新しいドキュメントを作成し、特定の要求に追加します。

ドキュメントの更新

特定のドキュメントのデータを変更します。

ドキュメントを削除する

特定のドキュメントを完全に削除します。

ユーザーの workgroup の取得

特定の組織の特定ユーザーのすべての workgroup のリストを返します。

招待を取り消す

特定の要求に沿った現在のアクターへの招待を取り消します。

招待状の再送信

特定の要求に沿った現在のアクターへの招待状を再送します。

組織の workgroup の取得

特定の組織のすべての workgroup のリストを返します。

要求によるアクター データの取得

特定の要求のすべてのアクターのすべてのデータを返します。

要求のダウンロード

リクエストとその内容を .zip ファイルとしてダウンロードします。

要求の作成

新しい要求を作成します。

要求の削除

特定の要求を完全に削除します。

要求の更新

特定の要求のデータを変更します。

要求の送信

ワークフローを開始し、特定の要求の最初のアクターに招待を送信します。

要求データの取得

特定の要求のすべての (メタ) データを返します。

アクター データの取得

特定のアクターのすべてのデータを返します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

Document ID
documentId True guid

ドキュメントの一意の ID。

アクター ID
actorId True guid

アクターの一意の ID。

戻り値

アクターの作成

新しいアクターを作成し、ドキュメントに追加します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

Document ID
documentId True guid

ドキュメントの一意の ID。

Action
action True string

アクターが実行する必要があるアクション。

First name
firstname True string

アクターの名。

接頭辞
prefix string

アクターの敬称。

Last name
lastname True string

アクターの姓。

電子メールアドレス
email True string

アクターのメール アドレス。

携帯電話番号
mobile True string

アクターの携帯電話番号。

期限
deadline True date-time

アクションがアクターによって実行されている必要がある日付と時刻。

Language
language True string

招待状の言語。

Use strong verification
validateRealIdentity True boolean

このアクターには、より強力な識別方法を使用します。

dossierPersonId
dossierPersonId integer
message
message string
Signing field
fieldName string

このアクターが署名するドキュメント内の既存の署名フィールドの名前。

プレースホルダー
placeholder string

アクターが署名を入れる必要があるドキュメント内の特定のプレースホルダーのテキスト。

戻り値

アクターの削除

特定のアクターを完全に削除します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

Document ID
documentId True guid

ドキュメントの一意の ID。

アクター ID
actorId True guid

アクターの一意の ID。

アクターの更新

特定のアクターのデータを変更します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

Document ID
documentId True guid

ドキュメントの一意の ID。

アクター ID
actorId True guid

アクターの一意の ID。

Action
action True string

アクターが実行する必要があるアクション。

First name
firstname True string

アクターの名。

接頭辞
prefix string

アクターの敬称。

Last name
lastname True string

アクターの姓。

電子メールアドレス
email True string

アクターのメール アドレス。

携帯電話番号
mobile True string

アクターの携帯電話番号。

期限
deadline True date-time

アクションがアクターによって実行されている必要がある日付と時刻。

Language
language True string

招待状の言語。

Use strong verification
validateRealIdentity True boolean

このアクターには、より強力な識別方法を使用します。

dossierPersonId
dossierPersonId integer
message
message string

戻り値

ドキュメント データの取得

特定のドキュメントのすべての (メタ) データを返します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

Document ID
documentId True guid

ドキュメントの一意の ID。

戻り値

ドキュメントの一般的なメタデータ

ドキュメントによるアクター データの取得

特定のドキュメントのすべてのアクターのすべてのデータを返します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

Document ID
documentId True guid

ドキュメントの一意の ID。

Action completed
hasActed boolean

アクションを完了したか完了していないアクターのみを返し、空白のままにすると、すべてのアクターを返します。

戻り値

ドキュメントの作成

新しいドキュメントを作成し、特定の要求に追加します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

このドキュメントが属する要求の一意の ID。

File
file True file

処理するファイル (特定の filetypes のみ)。

戻り値

ドキュメントの一般的なメタデータ

ドキュメントの更新

特定のドキュメントのデータを変更します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

Document ID
documentId True guid

ドキュメントの一意の ID。

Document name
name string

特定のドキュメントの名前

Document file name
filename string

特定のドキュメントのファイル名

Document type
documentType True string

特定のドキュメントの種類。 (例: 通常のPDF、財務諸表、監査報告書など..)。

戻り値

ドキュメントの一般的なメタデータ

ドキュメントを削除する

特定のドキュメントを完全に削除します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

Document ID
documentId True guid

ドキュメントの一意の ID。

ユーザーの workgroup の取得

特定の組織の特定ユーザーのすべての workgroup のリストを返します。

パラメーター

名前 キー 必須 説明
Organisation ID
organisationId True guid

組織の一意 ID。

Username
username True email

ユーザーの Emailaddress

戻り値

招待を取り消す

特定の要求に沿った現在のアクターへの招待を取り消します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

招待状の再送信

特定の要求に沿った現在のアクターへの招待状を再送します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

組織の workgroup の取得

特定の組織のすべての workgroup のリストを返します。

パラメーター

名前 キー 必須 説明
Organisation ID
organisationId True guid

組織の一意 ID。

戻り値

要求によるアクター データの取得

特定の要求のすべてのアクターのすべてのデータを返します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

Has actor acted on the request
hasActed boolean

アクターがドキュメントに対して既にアクションを実行したかどうかを確認するための読み取り専用の値。

戻り値

要求のダウンロード

リクエストとその内容を .zip ファイルとしてダウンロードします。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

戻り値

返答
file

要求の作成

新しい要求を作成します。

パラメーター

名前 キー 必須 説明
要求名
name True string

特定の要求の名前。

Workgroup ID
workgroupId guid

workgroup を表す一意の ID。

Security clearance level
clearancelevel True integer

特定の要求に対するセキュリティ権限のレベル。

Request owner
owner email

特定の要求の所有者であるユーザー。

戻り値

要求の削除

特定の要求を完全に削除します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

要求の更新

特定の要求のデータを変更します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

要求名
name True string

特定の要求の名前。

Workgroup ID
workgroupId guid

workgroup を表す一意の ID。

Security clearance level
clearancelevel True integer

特定の要求に対するセキュリティ権限のレベル。

Request owner
owner email

特定の要求の所有者であるユーザー。

戻り値

要求の送信

ワークフローを開始し、特定の要求の最初のアクターに招待を送信します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

要求データの取得

特定の要求のすべての (メタ) データを返します。

パラメーター

名前 キー 必須 説明
要求 ID
requestId True guid

要求を表す一意の ID。

認証キー
callbackAuthenticationKey string

トリガーによって提供される認証キー。

戻り値

トリガー

イベントが要求で発生した場合

statuschange 時のコールバック用の url を登録します。 PKIsigning プラットフォームは、この組織内の書類の statusupdates をこの url に報告します。

イベントが要求で発生した場合

statuschange 時のコールバック用の url を登録します。 PKIsigning プラットフォームは、この組織内の書類の statusupdates をこの url に報告します。

パラメーター

名前 キー 必須 説明
イベントの種類
Events True array of string

このトリガーが通知されるリクエストで発生するイベント タイプのリスト

Organisation ID
organisationId True guid

組織の一意 ID。

戻り値

名前 パス 説明
要求 ID
PkisId guid

要求を表す一意の ID。

要求の状態
DossierStatus string

書類のステータス。

Reason
Reason string

変更の理由。

認証キー
AuthenticationKey string

要求のメタデータを取得するためのヘッダー。

定義

ExtendedSignerModel

名前 パス 説明
Signing field
fieldName string

このアクターが署名するドキュメント内の既存の署名フィールドの名前。

プレースホルダー
placeholder string

アクターが署名を入れる必要があるドキュメント内の特定のプレースホルダーのテキスト。

Action
action string

アクターが実行する必要があるアクション。

First name
firstname string

アクターの名。

接頭辞
prefix string

アクターの敬称。

Last name
lastname string

アクターの姓。

電子メールアドレス
email string

アクターのメール アドレス。

携帯電話番号
mobile string

アクターの携帯電話番号。

期限
deadline date-time

アクションがアクターによって実行されている必要がある日付と時刻。

Language
language string

招待状の言語。

Use strong verification
validateRealIdentity boolean

このアクターには、より強力な識別方法を使用します。

dossierPersonId
dossierPersonId integer
message
message string
アクター ID
id guid

特定のアクターの一意の ID。

Date of completion
signingDate date-time

アクターがアクションを実行した日付と時刻。

Action completed
hasSigned boolean
Full name
fullName string

アクターの名、敬称、姓を組み合わせたもの。

状態に関する情報
emailActivity array of EmailActivity

アクターによるアクションの実行プロセスに関するステータス情報。

documentId
documentId guid

EmailActivity

アクターに送信されたメール メッセージのメタデータ

名前 パス 説明
電子メール活動
event string

特定の要求とアクターのメール活動。

SMTP information
reason string

要求の一部として特定のアクターに送信されたメールの SMTP 情報。

Email date
timestamp date-time

要求の一部として特定のアクターに送信されたメールの日付。

電子メールの種類
pkisMessageType string

要求の一部として特定のアクターに送信されたメールの種類 (例: 招待状、リマインダーなど)。

Email request ID
pkisInviteId string

要求の一部として特定のアクターに送信されたメールの一意の ID。

電子メールアドレス
email string

要求の一部として特定のアクターに送信されたメールのメール アドレス。

SignerModel

アクターの特別な種類

名前 パス 説明
Action
action string

アクターが実行する必要があるアクション。

First name
firstname string

アクターの名。

接頭辞
prefix string

アクターの敬称。

Last name
lastname string

アクターの姓。

電子メールアドレス
email string

アクターのメール アドレス。

携帯電話番号
mobile string

アクターの携帯電話番号。

期限
deadline date-time

アクションがアクターによって実行されている必要がある日付と時刻。

Language
language string

招待状の言語。

Use strong verification
validateRealIdentity boolean

このアクターには、より強力な識別方法を使用します。

dossierPersonId
dossierPersonId integer
message
message string
Signing field
fieldName string

このアクターが署名するドキュメント内の既存の署名フィールドの名前。

プレースホルダー
placeholder string

アクターが署名を入れる必要があるドキュメント内の特定のプレースホルダーのテキスト。

DocumentMetaDataModel

ドキュメントの一般的なメタデータ

名前 パス 説明
Document name
name string

特定のドキュメントの名前。

Last document update
lastUpdate date-time

特定のドキュメントの最終更新日。

Number of document pages
pages integer

特定のドキュメントのページ数。

Document creation date
created date-time

特定のドキュメントの作成日。

Document ID
id guid

ドキュメントの一意の ID。

ドキュメントの状態
status string

特定のドキュメントのステータス。 (例: 新規、完了など..)。

Document contains signature
signed boolean

特定のドキュメントに 1 つ以上の署名が既に含まれているかどうかを示します。

Document signatures
signatures array of SignatureData

特定のドキュメントのすべての署名の一覧。

Document blank signature fields
emptySignatureFields array of SignatureField

特定のドキュメントのすべての空の署名フィールドの一覧。

Blank signature fields
containsBlankSignatureFields boolean

特定のドキュメントに空白の署名フィールドが含まれているかどうかを示します。

Document actors
actors array of ExtendedSignerModel

特定のドキュメントのすべてのアクターの一覧。

要求 ID
requestId guid

要求を表す一意の ID。

Request index
dossierIndex integer

特定の要求に属するすべてのドキュメントのインデックス。

documentSize
documentSize integer

特定の要求に属するドキュメントのサイズ。

documentType
documentType string

特定の要求に属するドキュメントの種類。

SignatureData

名前 パス 説明
Certificate subject fields
subject array of KeyValuePairOfStringAndString

特定の署名に使用される証明書の件名行からのフィールド。

Certificate issuer fields
issuer array of KeyValuePairOfStringAndString

特定の署名に使用される証明書の発行者行からのフィールド。

Signature date
date date-time

特定の署名を入れた日付と時刻。

Signing location
location string

署名時の特定のアクターの地理的位置。

Signing reason
reason string

署名時に特定のアクターによって提供された署名の理由。

Qualified Electronic Signature
euQualified boolean

特定の適格な署名 (QeS) が eIDAS 規則に準拠しているかどうかどうかを示します。

Advanced Electronic Signature
advanced boolean

特定の高度な署名 (AeS) が eIDAS 規則に準拠しているかどうかどうかを示します。

Qualified eSeal
eSeal boolean

署名または封印に使用される特定の証明書が、eIDAS 規則に準拠した適格 eシールであるかどうかを示します。

Actor IP address
ipAddress string

特定のアクターの IP アドレス

Signature field
signatureField string

署名されたフィールド

Signature image
signatureImage string

アクターが選択した特定の署名に使用された画像ファイル。

KeyValuePairOfStringAndString

名前 パス 説明
key
key string
価値
value string

SignatureField

名前 パス 説明
Signature field name
name string

特定の署名フィールドの名前

Signature field page
page integer

特定のドキュメントに特定の署名フィールドが配置されるページ。

Signature field width coordinate
x double

特定のドキュメントに配置されているページに対する特定の署名フィールドの位置の幅値。

Signature field hight coordinate
y double

特定のドキュメントに配置されているページに対する特定の署名フィールドの位置の高さ値。

Signature field hight
height double

特定の署名フィールドの高さ値。

Signature field width
width double

特定の署名フィールドの幅値。

OrganisationWorkgroup

書類内で使用される workgroup

名前 パス 説明
Workgroup ID
id guid

workgroup を表す一意の ID

Workgroup name
name string

特定の workgroup の名前

RequestModel

名前 パス 説明
要求 ID
id guid

要求を表す一意の ID

要求名
dossierName string

特定の要求の名前。

Request documents
documents array of DocumentModel

この要求に含まれるドキュメントの一覧。

要求の状態
status string

特定の要求に対するステータス。 (例: 新規、完了など..)。

Request actors
actors array of ExtendedSignerModel

特定の要求に対するすべてのアクターの一覧。

Document signatures
signatures array of SignatureData

特定のドキュメントに対するすべての署名の一覧。

要求の種類
dossierType string

特定の要求の種類。 (例: PDF、SBR Assurance など..)。

Cancelation reason
reasons string

ユーザーまたはアクターによる特定の要求に対するキャンセルの理由。

Signer note
signerNote string

署名以外のアクションを持たない 1 人以上のアクターに対するメモ。

Recipient Note
recipientNote string

ダウンロード以外のアクションを持たない 1 人以上のアクターに対するメモ。

Approver note
accorderNote string

承認要求以外のアクションを持たない 1 人以上のアクターに対するメモ。

Request expire date
expires date-time

特定の要求に対する有効期限の日付と時刻。

状態に関する情報
emailActivity array of EmailActivity

アクターによるアクションの実行プロセスに関するステータス情報。

My request
myDossier boolean

特定の要求の所有者であるかどうかを示します。

Workgroup ID
workgroup guid

workgroup を表す一意の ID。

Security clearance level
clearancelevel integer

特定の要求に対するセキュリティ権限のレベル。

DocumentModel

名前 パス 説明
Document ID
id guid

ドキュメントの一意の ID

Document name
name string

特定のドキュメントの名前

Document type
documentType string

特定のドキュメントの種類。

Request index
dossierIndex integer

特定の要求に属するすべてのドキュメントのインデックス。

ドキュメントの状態
documentstatus string

特定のドキュメントのステータス。 (例: 新規、完了など..)。

Document actors
actors array of SignerModel

特定のドキュメントのすべてのアクターの一覧。

file

これは基本的なデータ型 'ファイル' です。