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

添付ファイルを追加 PDF - ファイル埋め込み API

PDF4me 添付ファイルを追加 PDF ファイル添付を追加できます PDF 文書を作成し、埋め込みファイルを含む包括的な文書パッケージを作成します。 API サービスプロセス PDF ドキュメントやさまざまな添付ファイルタイプを直接埋め込む PDFs. API ソースを受け取る PDF ファイルと添付ファイル REST API 通話を利用して Base64 安全なファイル送信のためのエンコード。複数のファイル形式とバッチ添付ファイル処理をサポートするこのソリューションは、信頼性の高いドキュメント管理システム、エンタープライズワークフロー、およびビジネスアプリケーションに最適です。 PDF 添付ファイル機能。

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

認証 API リクエスト​

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

Get your api Key

主な機能​

  • 複数のファイル形式テキスト、画像、ドキュメントなど、さまざまな添付ファイル形式に対応
  • バッチ添付ファイル: 1つのファイルに複数の添付ファイルを追加する PDF 書類
  • Base64 エンコーディング: 安全なファイルコンテンツ送信 Base64 エンコーディング
  • 文書保存: オリジナルを維持します PDF 添付ファイルを追加しながら構造化
  • 柔軟な命名規則: 整理しやすいように添付ファイル名をカスタマイズ
  • プロフェッショナルなパッケージング: 埋め込みリソースを含む包括的なドキュメントパッケージを作成する

REST API 終点​

の PDF4me REST API 標準を使用する HTTP リソースとやり取りするためのメソッド。添付ファイルの追加操作はすべて単一のエンドポイントを介して実行されます。

  • 方法： POST
  • 終点： /api/v2/AddAttachmentToPdf

REST API パラメータ​

添付ファイルの追加に使用するパラメータの完全なリスト PDF REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。

重要： アスタリスク (*) が付いているパラメータは必須であり、提供する必要があります。 API 正しく機能するため。

パラメータ必須その機能例
jobIdExtOptionalYour own reference for this call. It is stored with the API call log so you can correlate calls with your jobs. Type: string.
integrationsOptionalIntegration identifiers, forwarded unchanged with the job's notification settings. Type: array.
isAsyncOptionalSet 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.true
docNameOptionalSource 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.output.pdf
docContentRequiredThe 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.JVBERi...
docContentBytesOptionalAlternative raw byte payload for the source file. Type: string.
callBackUrlOptionalOptional URL notified when an asynchronous job completes. Type: string.
attachmentsOptionalRequired. Files to attach to the PDF. Each item needs `docName` (file name with extension) and `docContent`; an item with an empty `docContent` fails with `Attachment File is empty`. Type: array.See example below

添付ファイルオブジェクトの構造​

各アイテム attachments 配列は、以下の構造を持つオブジェクトでなければなりません。

出力​

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

同期処理（デフォルト）

いつ async 設定されていないか、 false、 API リクエストを即座に処理します。

ステータスコード: 200 OK

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

応答本文：

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}

回答欄:

  • ドキュメント名 （文字列）：出力 PDF ファイル名
  • ドキュメントコンテンツ (文字列): PDF 添付ファイルが埋め込まれたファイル、エンコード形式 Base64 弦

使用方法：

  1. 抽出する docContent からのフィールド JSON 応答
  2. 解読する Base64 バイナリを取得する文字列 PDF データ
  3. 保存または処理 PDF 必要に応じてファイルする

例（JavaScript）：

const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes

リクエスト例​

ヘッダ​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

注記：

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

ペイロード​

添付ファイル1件：

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "attachments": [
    {
      "docName": "output.txt",
      "docContent": "RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA=="
    }
  ]
}

複数の添付ファイル:

{
  "docName": "output.pdf",
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "attachments": [
    {
      "docName": "file1.txt",
      "docContent": "RXhhbXBsZSBvZiBhdHRhY2htZW50IGZpbGUuIA=="
    },
    {
      "docName": "file2.pdf",
      "docContent": "JVBERi0xLjQKJeLjz9MK..."
    }
  ],
  "async": true
}

コードサンプル​

の PDF4me 添付ファイルを追加 PDF REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。

C# （CSharpサンプル

完了 C# 添付ファイルを追加するための実装 PDF:

PDF 添付ファイル機能​

添付ファイルの処理​

  • 複数のファイル形式テキストファイル（.txt、.csv、.log）、ドキュメント（.pdf、.doc、.docx、.xls、.xlsx）、画像（.jpg、.jpeg、.png、.gif）、アーカイブ（.zip、.rar）、その他のファイル形式など、さまざまな添付ファイル形式をサポートしています。
  • バッチ処理: 1つのファイルに複数の添付ファイルを追加する PDF 添付ファイルオブジェクトの配列を提供することにより、1回の操作でドキュメントを処理
  • Base64 エンコーディングファイルコンテンツの安全な送信 Base64 エンコーディング
  • ファイル命名規則: 各添付ファイルには以下を含める必要があります docName 適切なファイル拡張子付き

文書の強化​

  • PDF 保存: オリジナルを維持します PDF 添付ファイルを追加しながら構造とコンテンツ
  • ファイル整理:埋め込み添付ファイルのカスタム命名と整理 docName 分野
  • 文書の携帯性: 関連するすべてのファイルが埋め込まれた自己完結型のドキュメント パッケージを作成します。 PDF
  • プロフェッショナルなパッケージング配布用の包括的なドキュメントパッケージを作成する

応答処理​

  • 同期処理デフォルトでは、 API リクエストを同期的に処理し、 PDF 添付ファイルあり（ステータス200）
  • 非同期処理： セット async: true 非同期処理を有効にする。 API ポーリングで202ステータスを返します URL で Location ヘッダー
  • 二値応答: その API 返します PDF 成功した場合、バイナリコンテンツとしてファイル（application/pdf）

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

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

  • 法的文書証拠ファイル、契約書、および裏付けとなる書類を含める
  • 裁判所への提出書類裁判所への提出書類や法的意見書に裏付けとなる書類を添付する
  • クライアントドキュメントクライアント向けドキュメントと関連資料をパッケージ化する
  • コンプライアンス文書証明書、免許証、規制関連書類を含める

ヘルプが必要な場合​

Get Your API KeyAPI SamplesGetting Started