メインコンテンツへスキップ
PDF4me API統合AIとSDK知識ベース拡張機能APIテスターブログ

文書のセキュリティ - 文書のセキュリティ API

PDF4me 安全な文書 包括的なセキュリティ制御と編集制限により、Word 文書にパスワード保護とセキュリティ制限を追加できます。 API このサービスはWordファイルを処理し、パスワード保護、文書編集制限、読み取り専用保護、コメント専用アクセス、フォームフィールド編集、および改訂履歴追跡を適用します。 API Word文書コンテンツは以下を通じて受信されます REST API 通話を利用して Base64 安全なデータ送信のためのエンコード機能。セキュリティレベルとパスワード要件を完全に制御できるため、機密文書、共同編集、文書アクセス制御ワークフローに最適です。

関連ブログ記事
この機能に関するブログ記事はまだありません。近日公開予定です。
その間、PDF4me ブログを閲覧して、あらゆるプラットフォームのチュートリアルやワークフローをご覧ください。
ブログをご覧ください →

認証 API リクエスト​

アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。

Get your api Key

主な機能​

  • パスワード保護: ドキュメントを開く際にパスワードを要求するようにする
  • 文書保護: さまざまな保護タイプを使用して編集機能を制限します
  • 読み取り専用セキュリティ: 不正な編集を防ぐため、ドキュメントを読み取り専用にする
  • コメント専用アクセスコメントの追加または変更のみを許可する
  • フォームフィールドの編集フォームフィールドのみに編集を制限する
  • 改訂履歴追跡変更履歴と改訂履歴のみを許可する
  • 複合セキュリティパスワード保護と編集制限の両方を適用する
  • 柔軟なアクセス制御: 用途に応じて異なるセキュリティレベルを設定

REST API 終点​

の PDF4me REST API 標準を使用する HTTP リソースとやり取りするための方法。すべてのドキュメントセキュリティ操作は、単一のエンドポイントを介して実行されます。

  • 方法： POST
  • 終点： office/ApiV2Word/ApplySecurity

REST API パラメータ​

セキュアドキュメントのパラメータ一覧 REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。

重要： アスタリスク（*）が付いているパラメータは必須です。パスワードパラメータは、対応するセキュリティオプションが有効になっている場合に必須です。

パラメータ必須その機能例
documentRequiredSource file. `Name` must end in `.docx` or `.doc`.{ "Name": "document.docx" }
document.NameRequiredFile name including its extension. Type: string.{ "Name": "document.docx" }
docContentRequiredThe source file, base64-encoded. Type: string.base64EncodedDocumentContent
isAsyncOptionalProcess the request in the background. The call returns `202 Accepted`; poll the `Location` URL (`GetActionStatus`) for the result. Type: boolean.
secureOnOpenOptional`"yes"` requires a password to open the document. Type: string."yes"
secureOnOpenPasswordOptionalPassword to open the document. Required when `secureOnOpen` is `"yes"`. Type: string."SecurePass123!"
securityOptionsOptionalObject carrying this operation's settings. Its fields are the securityOptions rows below.{ "protectionType": "ReadOnly", "protectionPassword": "EditPass456!" }
securityOptions.protectionTypeOptionalWhat other people can change. Not case-sensitive. Type: string.
securityOptions.protectionPasswordOptionalPassword to remove the editing restriction. Required for every type except `NoProtection`. Type: string.

保護タイプのオプション​

の API 文書編集制限に関して、異なる保護タイプを提供します。

保護タイプ説明使用事例
NoProtection編集制限なし（デフォルト）自由に編集できる文書
ReadOnly文書は編集できません。閲覧のみ可能です。最終文書、公開報告書
AllowCommentsコメントのみ追加・変更可能です文書レビューのワークフロー
AllowFormFieldsフォームフィールドのみ編集可能です。記入可能なフォーム、アンケート
AllowRevisions変更履歴/改訂履歴のみ記録可能変更履歴を追跡する共同編集機能

セキュリティ設定​

パスワード保護（パスワードを開く）​

  • 目的ドキュメントを開くにはパスワードが必要です
  • 使用時期機密文書、機密情報
  • 要件: secureOnOpenPassword 提供する必要があるのは secureOnOpen は "yes"
  • 強さ推奨文字数：英数字と特殊文字を含む8文字以上

文書保護（編集制限）​

  • 目的: 文書の閲覧は許可しつつ、編集機能を制限します。
  • 使用時期共同編集、フォーム配布、レビューワークフロー
  • 要件: securityOptions.protectionPassword 提供する必要があるのは securityOptions.protectionType 「保護なし」ではありません
  • 柔軟性: オープンパスワードと組み合わせることで、二重セキュリティを実現できます。

出力​

の PDF4me 安全な文書 REST API 処理モードに基づいて異なる応答を返します。 API Word文書をとして返します Base64-エンコードされた文字列 JSON フォーマットバイナリデータとしてではなく。

同期処理（デフォルト）

の API リクエストを処理し、以下を返します。

ステータスコード: 200 OK

コンテンツタイプ: application/json

応答本文：

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}

回答欄:

  • 書類 （stringセキュリティ設定が適用された Word 文書をエンコードしたもの Base64 弦
  • ファイル名 （string出力Wordファイル名
  • 成功 （boolean): リクエストが成功したかどうかを示します
  • エラーメッセージ （string または null): 成功が偽の場合のエラーの詳細

使用方法：

  1. 抽出する document からのフィールド JSON 応答 （Base64）
  2. 解読する Base64 バイナリ形式のWord文書データを取得する文字列
  3. 必要に応じてWordファイルを保存または処理する。
  4. セキュリティ設定によっては、Wordで文書を開く際にパスワードが必要になります。

例（JavaScript）：

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes - document is password protected

リクエスト例​

ヘッダ​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

注記：

  • 手に入れよう API 鍵から PDF4me ダッシュボード
  • の API キーは Base64 エンコードされ、「Basic」がプレフィックスとして付加されています。 Authorization ヘッダー
  • 例: API 重要なのは abc123エンコードして Base64 そして使用する Authorization: Basic YWJjMTIz

ペイロード​

基本的な例（パスワード保護のみ）：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "yes",
 "secureOnOpenPassword": "SecurePass123!"
}

高度な例（パスワード＋読み取り専用保護）：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "yes",
 "secureOnOpenPassword": "SecurePass123!",
 "securityOptions": {
 "protectionType": "ReadOnly",
 "protectionPassword": "EditPass456!"
 }
}

コメント専用保護の例：

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "no",
 "securityOptions": {
 "protectionType": "AllowComments",
 "protectionPassword": "ReviewPass789!"
 }
}

フォームフィールド保護の例：

{
 "document": { "Name": "form.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "no",
 "securityOptions": {
 "protectionType": "AllowFormFields",
 "protectionPassword": "FormPass2024!"
 }
}

コードサンプル​

の PDF4me 安全な文書 REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。

C# （CSharpサンプル

完了 C# Word文書を保護するための実装例：

業界におけるユースケースとアプリケーション​

法律・専門サービスにおけるユースケース

  • 機密顧客文書機密性の高い法的文書にパスワード保護を適用する
  • 契約セキュリティ: 顧客による確認のために読み取り専用保護を施した安全な契約書
  • 法的書式配布法的フォームにフォームフィールド保護を適用する
  • 文書レビュー法的文書のレビューにはコメントのみの保護を使用する

ヘルプが必要な場合​

Get Your API KeyAPI SamplesGetting Started