PDF文書を暗号化する API
PDF4me ドキュメント保護 PDF をパスワードで保護し、受信者がそれに対してできることを制限する REST エンドポイントです。ファイルを Base64 として POST します。 /api/v2/Protect パスワードとアクセス許可フラグを設定すると、AES暗号化された新しいPDFファイルが返されます。印刷、コピー、編集、フォームへの入力は、許可した場合のみ可能です。
このエンドポイントの機能
PDF4me ドキュメントを保護する 暗号化する PDF パスワードを使用して、単一の権限フラグを設定します REST 電話してください。 PDF として Base64パスワードと許可する操作(印刷、コピー、注釈、フォーム入力)を選択し、新しい AES暗号化された PDF 応答では、適用された暗号化は AES-128 または AES-256 あたり PDF 仕様、 GDPR、 HIPAAおよびその他のコンプライアンス主導型のワークフロー。
認証 API リクエスト
毎 PDF4me REST API 電話にはあなたの API キー Authorization ヘッダー。開発者ダッシュボードからキーを作成または選択し、サーバー側に保持してください。ブラウザのコードに公開しないでください。
見逃してはならない重要な事実
パスワード フィールドゲート文書の開放。 PDFの許可 enum は、ドキュメントを開いた後にユーザーが実行できる操作を制御します。両方を組み合わせて使用して、 PDF パスワードが必要で、印刷やコピーも無効になる。PDFの許可 ブロックされています。 なし 開く以外のすべてのアクションをブロックするか、特定のフラグなど フォームに記入する フォームへの入力のみを許可し、それ以外の操作は一切許可しない。REST API 終点
方法: 役職
URL: https://api.pdf4me.com/api/v2/Protect
送信 コンテンツタイプ: application/json そして 承認 ヘッダーにあなたの API キーを設定します。 非同期 に 間違い 同期応答の場合(HTTP 暗号化された200 PDF 生のバイナリバイトとして)、または 真実 受け取る HTTP 202プラスa 位置 バイナリで200が返されるまでポーリングするヘッダー PDF。
Postmanリクエストの設定
| 設定 | 価値 |
|---|---|
| Method | POST |
| URL | https://api.pdf4me.com/api/v2/Protect |
| Headers | Content-Type: application/json |
| Authorization | Basic Auth with your API key, or header Authorization: Basic YOUR_API_KEY |
| Body | raw JSON with docContent, docName, password, pdfPermission, and async fields |
| Response (sync) | When async is false: HTTP 200 with the encrypted PDF as raw binary bytes. Save the response body directly to a .pdf file. |
| Response (async) | When async is true: HTTP 202 with a Location header. GET that URL until you receive 200 plus the binary PDF. Useful for large files or slow networks. |
パラメータ
常に必須: ドキュメントコンテンツ、 ドキュメント名、 パスワード、 PDFの許可. 非同期 フラグはオプションです(デフォルトは 間違い)そして、レスポンスを即座に返すか、ポーリングURL経由で返すかを制御します。
| パラメータ | 必須 | その機能 | 例 |
|---|---|---|---|
| jobIdExt | Optional | Your own reference for this call. It is stored with the API call log so you can correlate calls with your jobs. Type: string. | |
| integrations | Optional | Integration identifiers, forwarded unchanged with the job's notification settings. Type: array. | |
| isAsync | Optional | Set to `true` to process the action asynchronously and get a job to poll at `/api/v2/GetActionStatus`. Only honoured by actions that support asynchronous processing. Type: boolean. | false |
| docName | Optional | Source file name including its extension. Several actions dispatch on the extension, so it should always be set; when omitted a per-action default is used. Type: string. | invoice.pdf |
| docContent | Required | The source file. Accepts the base64-encoded file content, a `pdf4meblobid://<id>` reference to a previously uploaded blob, or an `https` URL to the source document. Required: an empty value fails with `File is empty`. Type: string. | JVBERi0xLjQK... |
| docContentBytes | Optional | Alternative raw byte payload for the source file. Type: string. | |
| callBackUrl | Optional | Optional URL notified when an asynchronous job completes. Type: string. | |
| password | Optional | Password needed to open the protected PDF. It is set as both the user and the owner password. Type: string. | Str0ng-P@ss! |
| pdfPermission | Optional | An unrecognised value is rejected with 400. Type: string. | Fill Forms |
どのpdfPermissionフラグを選択すればよいですか?
パスワードとパーミッションフラグは、それぞれ異なる種類のものから保護する。パスワードはアクセスを許可するものであり、パーミッションフラグはアクセス後に何が起こるかを制御するものである。
| パスワードと権限 | password 分野 | pdfPermission 分野 |
|---|---|---|
| 保護する | 許可されていない開口部 | 開封後の望ましくない動作 |
| 影響を受ける人々 | パスワードをお持ちでない方 | 文書を開いたすべての人 |
| 典型的な使用例 | 機密配送 | 読み取り専用契約書、校正コピー |
| 最も制限的な値 | 強力で固有のパスワード | None (オープンのみ) |
全て何でも許されるなしオープンのみコピーテキストまたは画像を開いてコピーする注釈を付ける開いて注釈を付けるフォームに記入するフォームフィールドを開いて入力する障害者支援アクセシビリティツールで開く組み立てるページレベルの変更が可能デジタルプリント低解像度印刷のみリクエスト例
例A:パスワードのみで暗号化(All 許可)
{
"docContent": "JVBERi0xLjQK...",
"docName": "invoice.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "All",
"async": false
}
例 B: 最大限の制限で暗号化 (None)
ブロック印刷、コピー、編集、注釈付け、フォーム入力。
{
"docContent": "JVBERi0xLjQK...",
"docName": "confidential.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "None",
"async": false
}
例C:暗号化してフォーム入力のみを許可する
受領者が記入する必要はあるものの再配布してはならない機密性の高い受付フォームに便利です。
{
"docContent": "JVBERi0xLjQK...",
"docName": "intake-form.pdf",
"password": "Form-2026",
"pdfPermission": "Fill Forms",
"async": true
}
応答成功 (同期、 async: false)
HTTP 暗号化された200 PDF 生のレスポンスボディとして(バイナリ) application/pdf)。 いいえ JSON ラップ処理。応答バイトを直接ファイルに保存します。
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="protected.pdf"
<binary PDF bytes>
応答成功 (非同期、 async: true)
HTTP 202で Location ヘッダー。それをポーリングします。 URL と GET (同じ Authorization ヘッダー) を受け取るまで HTTP バイナリで200 PDF。
HTTP/1.1 202 Accepted
Location: https://api.pdf4me.com/api/v2/JobStatus/<job-id>
カールの例
同期モード(レスポンスボディを直接ファイルに保存):
curl -X POST https://api.pdf4me.com/api/v2/Protect \
-H "Content-Type: application/json" \
-H "Authorization: Basic YOUR_API_KEY" \
-o protected.pdf \
-d '{"docContent":"JVBERi0xLjQK...","docName":"invoice.pdf","password":"Str0ng-P@ss!","pdfPermission":"Fill Forms","async":false}'
非同期モード(注) -D headers.txt 捕獲するために Location (ポーリング用ヘッダー):
curl -X POST https://api.pdf4me.com/api/v2/Protect \
-H "Content-Type: application/json" \
-H "Authorization: Basic YOUR_API_KEY" \
-D headers.txt \
-d '{"docContent":"...","docName":"invoice.pdf","password":"Str0ng-P@ss!","pdfPermission":"Fill Forms","async":true}'
APIはどのような値を返しますか?
暗号化された文書自体。保護は以下で適用されます。 AES暗号化 定義により PDF仕様そのため、標準規格に準拠したリーダーはパスワードの入力を求め、アクセス許可フラグを適用します。
| 分野 | タイプ | 内容物 |
|---|---|---|
| Response body (HTTP 200) | Binary | The encrypted PDF bytes (Content-Type application/pdf). Write them straight to a new .pdf file; the source file is never modified. |
| Location header (HTTP 202) | String (URL) | Returned when async is true and processing continues in the background. GET this URL with the same Authorization header. |
| Poll response (HTTP 200) | Binary | The finished encrypted PDF, returned once the async job completes. |
| Poll response (HTTP 202) | Empty | Job still processing. Wait and poll the same Location URL again. |
コードサンプル
統合例
一般的なREST統合パターンTypical ways developers call Protect Document.
- 各請求書を読んでください PDF フォルダから、 S3 バケット、またはデータベースキュー。
- Base64-バイトをエンコードして POST 保護するために
PDFの許可設定フォームに記入する。 - 応答バイトを直接.pdfファイル(生バイナリ)に書き込み、暗号化されたファイルを電子メールまたはオブジェクトストレージにアップロードします。
- すべてのファイルをループ処理します。エンドポイントはステートレスであり、レート制限内であれば並列呼び出しも安全に行えます。
- POST 情報源 PDF に
/api/v2/Protect受信者のパスワードと選択された権限で。 - バイナリ応答バイトを取得し、再エンコードして Base64そして、
ドキュメントコンテンツへ デジタルサイネージ 終点。 - 1つ受け取る PDF それは両方です AES暗号化および暗号署名済み。法的およびコンプライアンス上の用途において、改ざん防止機能を備えています。
- 受信者ごとに固有のパスワードを生成します(UUID または共有秘密鍵から派生したもの)。
- POST そのパスワードで保護し、
PDFの許可設定なしすべてのコピーと印刷をブロックする。 - 暗号化されたメール PDF パスワードは、コンプライアンス監査証跡のために別のチャネルを通じて送信されます。