Dokobit Universal API

  • リファレンス

Dokobit Universal API は、システム内でドキュメントに署名したり、システム外でヨーロッパ全土のサードパーティから署名を収集したりできる多用途ツールです。 ドキュメント署名は、組織のブランドを使用したアカウントレス Dokobit 署名 (招待された参加者は Dokobit ポータルに登録せずにドキュメントに署名できます) インターフェイスで行われます。

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

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Dokobit
[URL] https://support.dokobit.com
メール developers@dokobit.com
Connector Metadata
発行者 Dokobit
Web サイト https://www.dokobit.com/solutions
プライバシー ポリシー https://www.dokobit.com/compliance/privacy-policy
カテゴリー 生産性

Dokobit Universal API は、システム内でドキュメントに署名したり、システム外でヨーロッパ全土のサードパーティから署名を収集したりできる多用途ツールです。 ドキュメント署名は、組織のブランドを使用したアカウントレス Dokobit 署名 (招待された参加者は Dokobit ポータルに登録せずにドキュメントに署名できます) インターフェイスで行われます。

前提条件

Dokobit Universal API を使用するには、sales@dokobit.com に連絡して API アクセス トークンを取得してください。

資格情報の入手方法

API アクセス トークンを取得するためには、営業担当まで ご連絡ください

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

  • ドキュメントの署名は、"DokobitUniversalAPICreateExternalSigning" または "DokobitUniversalAPICreateInternalSigning" アクションを使用して開始できます。 "DokobitUniversalAPICreateExternalSigning" を使用すると、参加者に署名の招待状が送信されます。 "DokobitUniversalAPICreateInternalSigning" は、ユーザーをリダイレクトできる署名 URL を生成します。
  • その後、対応するアクションで署名を管理し、参加者の追加/削除、リマインダーの送信、ドキュメントの署名状態の確認を行うことができます。
  • 参加者がドキュメントに署名した後、"DokobitUniversalAPIDownloadDocumentExternal" または "DokobitUniversalAPIDownloadDocumentInternal" アクションを使用してドキュメントをダウンロードできます。

既知の問題と制限事項

現在の実装では、ASiCe、ADoc、BDoc、EDoc コンテナーにサポートされている PDF ファイルで署名収集がサポートされています。

一般的なエラーと解決策

  • ファイルは Base64 でエンコードされたファイル コンテンツとして指定する必要があります。
  • ドキュメント署名の "タイプ" が "PDF" に設定されている場合、ドキュメント署名の開始時に単一の PDF ドキュメントが受け入れられます。 ファイルが複数ある場合は、署名の "タイプ" を "asice" または別のコンテナー形式に設定します。

接続を作成する

このコネクタは、次の認証タイプをサポートしています:
既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ 内容 必要
API キー securestring この API の API キー True

調整制限

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

アクション

Validation

Dokobit は、適格な電子署名と電子シールの検証を行う eIDAS 認定サービス プロバイダーです。 このアクションを使用して、署名されたファイルを検証のためにアップロードします。 サポートされているファイルの種類: "asice"、"asics"、"sce"、"bdoc"、"edoc"、"pdf"、"p7s"、"xml"。
アラームの送信

参加者がまだドキュメントに署名していない場合にのみ、アラーム メールを参加者に送信することを許可します。 外部署名フローでのみ機能します。
シール署名

書類は組織の電子シールで封印されます。 電子封印の資格のある証明書を取得するには、developers@dokobit.com のサポートに連絡してください。
内部ドキュメントのダウンロード

署名されたドキュメントをダウンロードします。
内部署名の状態を確認する

署名ステータスとともにドキュメントの情報を返します。
内部署名を作成する

内部署名により、システムから署名要求が開始されます。 この場合、参加者がリダイレクトされる署名 URL が生成されます。
内部署名を削除する

ドキュメントは所有者のアカウントから削除されます。 他の参加者は引き続きアクセスできます。
内部署名を更新する

既存の文書署名の属性を更新できます。
内部署名者の追加

示された参加者は、選択された役割を持つドキュメントにアクセスできます。
内部署名者を削除する

表示された参加者のドキュメントへのアクセスは取り消されます。
外部ドキュメントのダウンロード

署名されたドキュメントをダウンロードします。
外部署名の状態を確認する

署名ステータスとともにドキュメントの情報を返します。
外部署名を作成する

外部署名により、システムから非同期の署名要求が開始されます。 この場合、ユーザーは署名用のメールを受信し、ドキュメントに署名するとコールバックを受信します。
外部署名を削除する

ドキュメントは所有者のアカウントから削除されます。 他の参加者は引き続きアクセスできます。
外部署名を更新する

既存の文書署名の属性を更新できます。
外部署名者の追加

示された参加者は、選択された役割を持つドキュメントにアクセスできます。
外部署名者を削除する

表示された参加者のドキュメントへのアクセスは取り消されます。
検証 - PDF レポート

検証レポートを PDF でダウンロードします。
検証 - XML レポート

検証レポートを XML でダウンロードします。
検証 - XML 診断データ

XML で診断データをダウンロードします。
検証 - 詳細な PDF レポート

詳細な検証レポートを PDF でダウンロードします。
電子送信

ドキュメントの電子送信は、Dokobit Universal API でドキュメントを安全に共有するために使用されます。

Validation

操作 ID:
DokobitUniversalAPIValidation

Dokobit は、適格な電子署名と電子シールの検証を行う eIDAS 認定サービス プロバイダーです。 このアクションを使用して、署名されたファイルを検証のためにアップロードします。 サポートされているファイルの種類: "asice"、"asics"、"sce"、"bdoc"、"edoc"、"pdf"、"p7s"、"xml"。

パラメーター

名前 キー 必須 型 説明
件名
 name True string

ファイル名。
コンテンツ
 content True string

Base64 でエンコードされたファイルのコンテンツ。

戻り値

名前 パス 型 説明
アップロードの状態
 status string

アップロードの状態。
検証トークン
 token string

検証トークン。

アラームの送信

操作 ID:
DokobitUniversalAPIReminder

参加者がまだドキュメントに署名していない場合にのみ、アラーム メールを参加者に送信することを許可します。 外部署名フローでのみ機能します。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。
署名者トークン
 signer True string

参加者のトークン。
Message
 message string

署名者へのリマインダー メッセージ。

戻り値

名前 パス 型 説明
Status
 status string

状態。

シール署名

操作 ID:
DokobitUniversalAPISealSigning

書類は組織の電子シールで封印されます。 電子封印の資格のある証明書を取得するには、developers@dokobit.com のサポートに連絡してください。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。

戻り値

名前 パス 型 説明
Status
 status string

状態。

内部ドキュメントのダウンロード

操作 ID:
DokobitUniversalAPIDownloadDocumentInternal

署名されたドキュメントをダウンロードします。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。

戻り値

返答
object

内部署名の状態を確認する

操作 ID:
DokobitUniversalAPICheckInternalSigningStatus

署名ステータスとともにドキュメントの情報を返します。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。

戻り値

名前 パス 型 説明
署名状態
 status string

ドキュメント署名の状態。
件名
 name string

ユーザーに表示される署名名。
タイプ
 type string

ドキュメントのタイプ。
作成日
date_created string

ドキュメント署名が開始された日付。
期限
 deadline date-time

指定されたタイムゾーン フラグメントを使用した署名期限日。 例: 2018-11-05T13:15:30Z.
File Name
 filename string

ファイルの名前。
Files
 files array of object
件名
 files.name string

ファイル名。
Download URL
 files.url string

ファイルをダウンロードする URL。
MIME Type
 files.mime_type string

ファイル MIME の種類。
署名者
 signers array of object

参加者情報。
Token
 signers.token string

参加者のトークン。
件名
 signers.first_name string

参加者の名前。
Surname
 signers.last_name string

参加者の姓。
コード
 signers.code string

参加者のコード。
Country
 signers.country string

参加者の国。
メール
 signers.email string

参加者のメール アドレス。
タイプ
 signers.type string

タイプ。
Status
 signers.status string

参加者の状態。

内部署名を作成する

操作 ID:
DokobitUniversalAPICreateInternalSigning

内部署名により、システムから署名要求が開始されます。 この場合、参加者がリダイレクトされる署名 URL が生成されます。

パラメーター

名前 キー 必須 型 説明
タイプ
 type True string

ドキュメント形式。 使用可能な値: "pdf"、"asice"、"bdoc"、"edoc"、"adoc"、"adoc.cedoc"。
件名
 name True string

ユーザーに表示される署名名。
リダイレクト URI
 redirect_uri True string

署名が完了した後に署名者をリダイレクトするために使用されるリダイレクト URI。
要件を満たす署名が必要です
 require_qualified_signatures boolean

要件を満たす署名でのみ署名を許可します。 既定: "false"。
注釈の位置
 annotation_position string

PDF ドキュメント上の署名注釈の位置を選択できます。 使用可能な値: "first_top"、"first_bottom"、"last_top"、"last_bottom"、"none"。 既定: "first_top"。
注釈の個人コード
 annotation_personal_code boolean

"true" に設定すると、個人コードが注釈に表示されます。 PDF タイプの署名にのみ適用可能です。 既定: "false"。
ビデオ認識を許可する
 allow_video_identification boolean

ビデオベースの識別を使用した署名を許可します。 既定: "false"。
PDF をフラット化する
 flatten_pdf boolean

"true" に設定すると、ドキュメントはフラット化され、フォーム フィールドがドキュメント コンテンツの一部となり、署名後に編集できなくなります。 PDF タイプの署名にのみ適用可能です。 既定: "false"。
許可されている署名方法
 allowed_signing_methods array of string

特定の署名方法のみを許可します。 使用可能な値: "mobile"、"smartid"、"smartcard"、"eparaksts_mobile"、"bankid_no"、"bankid_se"、"audkenni_app"、"ftn"、"mitid"、"nemid"、"electronic_id'"、"itsme"、"idin"、 "swisscom"。
件名
 name True string

ファイル名。
コンテンツ
 content True string

Base64 でエンコードされたファイルのコンテンツ。
External ID
 external_id True string

システムからの参加者の一意のランダムな識別子。 一意のランダムな識別子がない場合は生成できます。
役割
 role string

参加者のロール。 既定: "署名者"。
カスタム理由
 custom_reason string

カスタム署名の理由。

戻り値

名前 パス 型 説明
Status
 status string

状態。
署名トークン
 token string

署名トークン。
署名者
 signers array of object

参加者の情報。
External ID
 signers.external_id string

システムからの参加者の一意のランダムな識別子。
Token
 signers.token string

参加者のトークン。
リダイレクト URI
 signers.redirect_uri string

署名する URL。

内部署名を削除する

操作 ID:
DokobitUniversalAPIDeleteInternalSigning

ドキュメントは所有者のアカウントから削除されます。 他の参加者は引き続きアクセスできます。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。

戻り値

名前 パス 型 説明
Status
 status string

状態。

内部署名を更新する

操作 ID:
DokobitUniversalAPIUpdateInternalSigning

既存の文書署名の属性を更新できます。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。
要件を満たす署名が必要です
 require_qualified_signatures boolean

要件を満たす署名でのみ署名を許可します。 既定: "false"。
ビデオ認識を許可する
 allow_video_identification boolean

ビデオベースの識別を使用した署名を許可します。 既定: "false"。
許可されている署名方法
 allowed_signing_methods array of string

特定の署名方法のみを許可します。 使用可能な値: "mobile"、"smartid"、"smartcard"、"eparaksts_mobile"、"bankid_no"、"bankid_se"、"audkenni_app"、"ftn"、"mitid"、"nemid"、"electronic_id'"、"itsme"、"idin"、 "swisscom"。

戻り値

名前 パス 型 説明
Status
 status string

状態。

内部署名者の追加

操作 ID:
DokobitUniversalAPIAddInternalSigner

示された参加者は、選択された役割を持つドキュメントにアクセスできます。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。
External ID
 external_id True string

システムからの参加者の一意のランダムな識別子。 一意のランダムな識別子がない場合は生成できます。
役割
 role string

参加者のロール。 既定: "署名者"。
カスタム理由
 custom_reason string

カスタム署名の理由。

戻り値

名前 パス 型 説明
Status
 status string

状態。
署名者
 signers array of object

参加者の情報。
External ID
 signers.external_id string

システムからの参加者の一意のランダムな識別子。
Token
 signers.token string

参加者のトークン。
件名
 signers.name string

参加者の名前。
Surname
 signers.surname string

参加者の姓。
メール
 signers.email string

参加者のメール アドレス。
コード
 signers.code string

参加者の個人コード (国内の ID 番号)。
Country Code
 signers.country_code string

参加者の国。
役割
 signers.role string

参加者のロール。
Company
 signers.company string

参加者の会社。
Position
 signers.position string

参加者の職位。
電話番号
 signers.phone string

参加者の電話番号。

内部署名者を削除する

操作 ID:
DokobitUniversalAPIDeleteInternalSigner

表示された参加者のドキュメントへのアクセスは取り消されます。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。
Token
 token True string

参加者のトークン。

戻り値

名前 パス 型 説明
Status
 status string

状態。

外部ドキュメントのダウンロード

操作 ID:
DokobitUniversalAPIDownloadDocumentExternal

署名されたドキュメントをダウンロードします。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。

戻り値

返答
object

外部署名の状態を確認する

操作 ID:
DokobitUniversalAPICheckExternalSigningStatus

署名ステータスとともにドキュメントの情報を返します。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。

戻り値

名前 パス 型 説明
署名状態
 status string

ドキュメント署名の状態。
件名
 name string

ユーザーに表示される署名名。
タイプ
 type string

ドキュメントの種類です。
作成日
date_created string

ドキュメント署名が開始された日付。
期限
 deadline date-time

指定されたタイムゾーン フラグメントを使用した署名期限日。 例: 2018-11-05T13:15:30Z.
File Name
 filename string

ファイルの名前。
Files
 files array of object
件名
 files.name string

ファイル名。
Download URL
 files.url string

ファイルをダウンロードする URL。
MIME Type
 files.mime_type string

ファイル MIME の種類。
署名者
 signers array of object

参加者情報。
Token
 signers.token string

参加者のトークン。
件名
 signers.first_name string

参加者の名前。
Surname
 signers.last_name string

参加者の姓。
コード
 signers.code string

参加者のコード。
Country
 signers.country string

参加者の国。
メール
 signers.email string

参加者のメール アドレス。
タイプ
 signers.type string

タイプ。
Status
 signers.status string

参加者の状態。

外部署名を作成する

操作 ID:
DokobitUniversalAPICreateExternalSigning

外部署名により、システムから非同期の署名要求が開始されます。 この場合、ユーザーは署名用のメールを受信し、ドキュメントに署名するとコールバックを受信します。

パラメーター

名前 キー 必須 型 説明
タイプ
 type True string

ドキュメント形式。 使用可能な値: "pdf"、"asice"、"bdoc"、"edoc"、"adoc"、"adoc.cedoc"。
件名
 name True string

ユーザーに表示される署名名。
ポストバック URL
 postback_url string

Webhook を処理するシステムの URL。
期限
 deadline date-time

指定されたタイムゾーン フラグメントを使用した署名期限日。 例: 2018-11-05T13:15:30Z.
ハード期限
 hard_deadline boolean

True に設定すると、"期限" に設定した後、参加者はこのドキュメントに署名できなくなります。 既定: "false"。
要件を満たす署名が必要です
 require_qualified_signatures boolean

要件を満たす署名でのみ署名を許可します。 既定: "false"。
注釈の位置
 annotation_position string

PDF ドキュメント上の署名注釈の位置を選択できます。 使用可能な値: "first_top"、"first_bottom"、"last_top"、"last_bottom"、"none"。 既定: "first_top"。
注釈の個人コード
 annotation_personal_code boolean

"true" に設定すると、個人コードが注釈に表示されます。 PDF タイプの署名にのみ適用可能です。 既定: "false"。
Comment
 comment string

参加者へのメッセージ。
ビデオ認識を許可する
 allow_video_identification boolean

ビデオベースの識別を使用した署名を許可します。 既定: "false"。
ドキュメントの保存を許可する
 allow_document_saving boolean

ユーザーがドキュメントを Dokobit ポータルに保存し、さらにアクションを実行できるようにします。 既定値: "true"。
PDF をフラット化する
 flatten_pdf boolean

"true" に設定すると、ドキュメントはフラット化され、フォーム フィールドがドキュメント コンテンツの一部となり、署名後に編集できなくなります。 PDF タイプの署名にのみ適用可能です。 既定: "false"。
許可されている署名方法
 allowed_signing_methods array of string

特定の署名方法のみを許可します。 使用可能な値: "mobile"、"smartid"、"smartcard"、"eparaksts_mobile"、"bankid_no"、"bankid_se"、"audkenni_app"、"ftn"、"mitid"、"nemid"、"electronic_id'"、"itsme"、"idin"、 "swisscom"。
件名
 name True string

ファイル名。
コンテンツ
 content True string

Base64 でエンコードされたファイルのコンテンツ。
External ID
 external_id True string

システムからの参加者の一意のランダムな識別子。 一意のランダムな識別子がない場合は生成できます。
件名
 name string

参加者の名前。
Surname
 surname string

参加者の姓。
メール
 email string

参加者のメール アドレス。
コード
 code string

参加者の個人コード (国内の ID 番号)。
Country Code
 country_code string

参加者の国コード。 個人コードが指定されている場合は必須。
役割
 role string

参加者のロール。 既定: "署名者"。
Company
 company string

参加者の会社名。
Position
 position string

参加者の職位。
電話番号
 phone string

参加者の電話番号。
シークエンス
 sequence integer

ドキュメントの承認および署名アクションの順序を設定することを許可します。
通知言語
 notifications_language string

通知言語を設定します。 使用可能な値: "en"、"lt"、"lv"、"ee"、"is"、"no"、"fr"、"se"、"de"。
カスタム理由
 custom_reason string

カスタム署名の理由。

戻り値

名前 パス 型 説明
Status
 status string

状態。
署名トークン
 token string

署名トークン。
署名者
 signers array of object

参加者の情報。
External ID
 signers.external_id string

システムからの参加者の一意のランダムな識別子。
Token
 signers.token string

参加者のトークン。
件名
 signers.first_name string

参加者の名前。
Surname
 signers.last_name string

参加者の姓。
コード
 signers.code string

参加者の個人コード (国内の ID 番号)。
Country
 signers.country string

参加者の国。
メール
 signers.email string

参加者のメール アドレス。

外部署名を削除する

操作 ID:
DokobitUniversalAPIDeleteExternalSigning

ドキュメントは所有者のアカウントから削除されます。 他の参加者は引き続きアクセスできます。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。

戻り値

名前 パス 型 説明
Status
 status string

状態。

外部署名を更新する

操作 ID:
DokobitUniversalAPIUpdateExternalSigning

既存の文書署名の属性を更新できます。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。
期限
 deadline date-time

指定されたタイムゾーン フラグメントを使用した署名期限日。 例: 2018-11-05T13:15:30Z.
ハード期限
 hard_deadline boolean

"True" に設定すると、参加者は、"期限" を設定した後にこのドキュメントに署名や承認ができなくなります。 既定: "false"。
要件を満たす署名が必要です
 require_qualified_signatures boolean

要件を満たす署名でのみ署名を許可します。 既定: "false"。
ビデオ認識を許可する
 allow_video_identification boolean

ビデオベースの識別を使用した署名を許可します。 既定: "false"。
ドキュメントの保存を許可する
 allow_document_saving boolean

ユーザーがドキュメントを Dokobit ポータルに保存し、さらにアクションを実行できるようにします。 既定値: "true"。
許可されている署名方法
 allowed_signing_methods array of string

特定の署名方法のみを許可します。 使用可能な値: "mobile"、"smartid"、"smartcard"、"eparaksts_mobile"、"bankid_no"、"bankid_se"、"audkenni_app"、"ftn"、"mitid"、"nemid"、"electronic_id'"、"itsme"、"idin"、 "swisscom"。

戻り値

名前 パス 型 説明
Status
 status string

状態。

外部署名者の追加

操作 ID:
DokobitUniversalAPIAddExternalSigner

示された参加者は、選択された役割を持つドキュメントにアクセスできます。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。
External ID
 external_id True string

システムからの参加者の一意のランダムな識別子。 一意のランダムな識別子がない場合は生成できます。
件名
 name string

参加者の名前。
Surname
 surname string

参加者の姓。
メール
 email string

参加者のメール アドレス。
コード
 code string

参加者のコード。
国番号
 country_code string

参加者の国コード。
役割
 role string

参加者のロール。 既定: "署名者"。
Company
 company string

参加者の会社。
Position
 position string

参加者の職位。
電話番号
 phone string

参加者の電話番号。
カスタム理由
 custom_reason string

カスタム署名の理由。
Comment
 comment string

参加者へのメッセージ。

戻り値

名前 パス 型 説明
Status
 status string

状態。
署名者
 signers array of object

参加者の情報。
External ID
 signers.external_id string

システムからの参加者の一意のランダムな識別子。
Token
 signers.token string

参加者のトークン。
件名
 signers.name string

参加者の名前。
Surname
 signers.surname string

参加者の姓。
メール
 signers.email string

参加者のメール アドレス。
コード
 signers.code string

参加者の個人コード (国内の ID 番号)。
Country Code
 signers.country_code string

参加者の国。
役割
 signers.role string

参加者のロール。
Company
 signers.company string

参加者の会社。
Position
 signers.position string

参加者の職位。
通知言語
 signers.notifications_language string

通知言語を設定します。 使用可能な値: "en"、"lt"、"lv"、"ee"、"is"、"no"、"fr"、"se"、"de"。
電話番号
 signers.phone string

参加者の電話番号。

外部署名者を削除する

操作 ID:
DokobitUniversalAPIDeleteExternalSigner

表示された参加者のドキュメントへのアクセスは取り消されます。

パラメーター

名前 キー 必須 型 説明
署名トークン
 token True string

署名トークン。
Token
 token True string

参加者のトークン。

戻り値

名前 パス 型 説明
Status
 status string

状態。

検証 - PDF レポート

操作 ID:
DokobitUniversalAPIValidationPDFReport

検証レポートを PDF でダウンロードします。

パラメーター

名前 キー 必須 型 説明
検証トークン
 token True string

DokobitUniversalAPIValidation アクションから受信した検証トークン。

戻り値

返答
object

検証 - XML レポート

操作 ID:
DokobitUniversalAPIValidationXMLReport

検証レポートを XML でダウンロードします。

パラメーター

名前 キー 必須 型 説明
検証トークン
 token True string

DokobitUniversalAPIValidation アクションから受信した検証トークン。

戻り値

返答
object

検証 - XML 診断データ

操作 ID:
DokobitUniversalAPIValidationXMLDiagnosticData

XML で診断データをダウンロードします。

パラメーター

名前 キー 必須 型 説明
検証トークン
 token True string

DokobitUniversalAPIValidation アクションから受信した検証トークン。

戻り値

返答
object

検証 - 詳細な PDF レポート

操作 ID:
DokobitUniversalAPIValidationDetailedPDFReport

詳細な検証レポートを PDF でダウンロードします。

パラメーター

名前 キー 必須 型 説明
検証トークン
 token True string

DokobitUniversalAPIValidation アクションから受信した検証トークン。

戻り値

返答
object

電子送信

操作 ID:
DokobitUniversalAPIeDelivery

ドキュメントの電子送信は、Dokobit Universal API でドキュメントを安全に共有するために使用されます。

パラメーター

名前 キー 必須 型 説明
タイプ
 type True string

ドキュメント形式。 使用可能な値: "pdf"、"asice"、"bdoc"、"edoc"、"adoc"、"adoc.cedoc"。
件名
 name True string

ユーザーに表示されるドキュメント名。
ポストバック URL
 postback_url string

Webhook を処理するシステムの URL。
Comment
 comment string

受信者に送るメッセージ。
件名
 name True string

ファイル名。
コンテンツ
 content True string

Base64 でエンコードされたファイルのコンテンツ。
External ID
 external_id True string

システムからの参加者の一意のランダムな識別子。 一意のランダムな識別子がない場合は生成できます。
コード
 code True string

受信者の個人コード (国内の ID 番号)。
Country Code
 country_code True string

受信者の国番号。 個人コードが指定されている場合は必須。 使用可能な値: "lt"、"lv"、"ee"、"is"。
メール
 email string

ドキュメントを送信するための受信者のメール。 電話が設定されていない場合は必須です。
電話番号
 phone string

ドキュメント SMS を送信するための受信者の電話番号。 メールアドレスが設定されていない場合は必須です。 SMS はメールアドレスが指定されていない場合にのみ送信されます。
通知言語
 notifications_language string

通知言語を設定します。 使用可能な値: "en"、"lt"、"lv"、"ee"、"is"、"no"、"fr"、"se"、"de"。

戻り値

名前 パス 型 説明
Status
 status string

状態。
ドキュメント トークン
 token string

ドキュメント トークン。
Recipients
 recipients array of object

受信者の情報。
External ID
 recipients.external_id string

システムからの参加者の一意のランダムな識別子。
Token
 recipients.token string

受信者のトークン。
コード
 recipients.code string

受信者の個人コード (国内の ID 番号)。
Country
 recipients.country string

受信者の国。
メール
 recipients.email string

受信者のメール。

定義

オブジェクト

’オブジェクト’ という種類です。