バーコードを追加する PDF - QR Code 統合 API
PDF4me バーコードを追加する PDF プロフェッショナルなバーコードを追加できます。 QR codes に PDF 正確な位置、サイズ、書式設定制御を備えたドキュメント。 API サービスプロセス PDF ファイルとバーコードを追加 Base64 安全な送信のためのエンコード。150種類以上のバーコードタイプをサポート。 QR codes、 Code128、 DataMatrix、 Aztec、 Hanxin、 PDF417また、特殊なフォーマットにも対応しており、このソリューションは在庫管理システム、配送ラベルの自動化、文書追跡ワークフロー、および企業バーコード統合に最適です。
認証 API リクエスト
アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。
主な機能
- 包括的なバーコードサポート: 150種類以上のバーコードタイプを含む QR codes、 Code128、 DataMatrix、 Aztec、 Hanxin、 PDF417郵便番号、および業界特有のフォーマット
- 精密な位置決め制御バーコードをどこにでも配置 PDF ミリメートルとポイントの両方の測定システムを使用して、ピクセル単位の精度でページを描画します。
- 高度なサイズオプション: 自動サイズ調整機能とカスタム幅/高さ制御による柔軟なバーコード寸法で最適なスキャン性能を実現
- プロフェッショナルなテキスト管理カスタマイズ可能な書式設定オプションを使用して、バーコードのテキスト表示、位置(上/下)、および可視性を設定します。
- 不透明度と透明度透かし効果、ドキュメントオーバーレイ、プロフェッショナルなプレゼンテーションのために、バーコードの透明度レベルを調整します。
- エンタープライズバッチ処理自動処理ワークフローを使用して、複数のページ、文書、または文書コレクション全体にバーコードを追加します。
REST API 終点
の PDF4me REST API 標準を使用する HTTP リソースとやり取りするための方法。すべてのバーコード操作は単一のエンドポイントを介して実行されます。
- 方法: POST
- 終点:
/api/v2/addbarcode
サポートされているバーコードの種類
150種類以上のバーコードタイプをサポートし、包括的な PDF 統合。
人気の1次元バーコード
- Code128 - ユニバーサルバーコード(最大255文字)
- Code39 英数字バーコード(最大43文字)
- EAN13/EAN8 - 小売商品コード(13文字または8文字)
- UPC-A/UPC-E - 北米小売(12/8文字)
人気の2次元バーコード
- QR Code - モバイルスキャン(最大4,296文字)
- DataMatrix - 高密度2D(最大2,335文字)
- PDF417 - 大容量データ(最大2,710文字)
- Aztec - 優れたエラー訂正機能(最大3,832文字)
特殊フォーマット
- 郵便番号: USPS、 Royal Mail、 Australia Post、 Deutsche Post
- 健康管理: HIBC、 GS1 DataBar、 Pharmacode
- ロジスティクス: MaxiCode、 SSCC-18、 ITF-14、 GS1-128
- QRコードのバリエーション: Micro QR、 iQR、 rMQR
REST API パラメータ
バーコードを追加する際のパラメータの完全なリスト PDF REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。
重要: アスタリスク (*) が付いているパラメータは必須であり、提供する必要があります。 API 正しく機能するため。
| パラメータ | 必須 | その機能 | 例 |
|---|---|---|---|
| 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. | true |
| 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. | output.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. | JVBERi... |
| docContentBytes | Optional | Alternative raw byte payload for the source file. Type: string. | |
| callBackUrl | Optional | Optional URL notified when an asynchronous job completes. Type: string. | |
| text | Optional | Required. Text to encode in the barcode. Type: string. | PDF4me Barcode Sample |
| barcodeType | Optional | An unrecognised value is rejected with 400. Type: string. | qrCode |
| alignX | Optional | An unrecognised value is rejected with 400. Type: string. | Right |
| alignY | Optional | An unrecognised value is rejected with 400. Type: string. | Bottom |
| heightInMM | Optional | Barcode height in millimetres. When `heightInMM` or `widthInMM` is set it overrides the `...InPt` size; 0 or empty leaves the size to the service. Type: string. | 40 |
| widthInMM | Optional | Barcode width in millimetres. When `heightInMM` or `widthInMM` is set it overrides the `...InPt` size; 0 or empty leaves the size to the service. Type: string. | 40 |
| heightInPt | Optional | Barcode height in points (1/72 inch). Ignored when a millimetre size is given. Type: string. | 113 |
| widthInPt | Optional | Barcode width in points (1/72 inch). Ignored when a millimetre size is given. Type: string. | 113 |
| marginXInMM | Optional | Horizontal distance in millimetres from the edge chosen by `alignX`. Overrides `marginXInPt` when either millimetre margin is set. Ignored when `alignX` is `center`. Type: string. | 20 |
| marginYInMM | Optional | Vertical distance in millimetres from the edge chosen by `alignY`. Overrides `marginYInPt` when either millimetre margin is set. Ignored when `alignY` is `middle`. Type: string. | 20 |
| marginXInPt | Optional | Horizontal distance in points from the edge chosen by `alignX`. Ignored when `alignX` is `center`. Type: string. | 57 |
| marginYInPt | Optional | Vertical distance in points from the edge chosen by `alignY`. Ignored when `alignY` is `middle`. Type: string. | 57 |
| opacity | Optional | Opacity from `0` (invisible) to `100` (fully opaque); values outside the range are clamped. Omitted or non-numeric counts as `0`. Type: string. | 100 |
| pages | Optional | Pages to stamp, e.g. `1`, `1,3,5`, `2-5`, `2-` (2 to the last page) or `all`. Type: string. | 1-3 |
| hideText | Optional | Hide the human-readable text under or above the barcode. Type: boolean. | true |
| showOnlyInPrint | Optional | Show the barcode only when the PDF is printed, not on screen. Type: boolean. | false |
| displayText | Optional | Where to show the human-readable text, `above` or `below` the barcode. Type: string. | below |
| isTextAbove | Optional | Show the human-readable text above the barcode instead of below it. Type: boolean. | false |
出力
の PDF4me バーコードを追加する PDF REST API 処理モードに基づいて異なる応答を返します。 API 返します PDF として Base64-エンコードされた文字列 JSON フォーマットバイナリデータとしてではなく。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同期処理(デフォルト)
いつ async 設定されていないか、 false、 API リクエストを即座に処理します。
ステータスコード: 200 OK
Content-Type: application/json
応答本文:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
回答欄:
- docName (文字列):出力 PDF ファイル名
- docContent (文字列): PDF バーコードが追加されたファイル、エンコードされた Base64 弦
使用方法:
- 抽出する
docContentからのフィールド JSON 応答 - 解読する Base64 バイナリを取得する文字列 PDF データ
- 保存または処理 PDF 必要に応じてファイルする
例 (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
非同期処理
いつ async: true 設定されている、 API リクエストを非同期的に処理します。
ステータスコード: 202 Accepted
レスポンスヘッダー:
Location: https://api.pdf4me.com/api/v2/addbarcode/poll/12345-abcde-67890
投票プロセス:
- 抽出する
Location202レスポンスのヘッダー - 投票する URL 使用 GET リクエスト
- 受信するまで投票を続けてください 200 OK 状態
- 最終回答には同じ内容が含まれています JSON フォーマット
docNameそしてdocContent(Base64)
投票例:
// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');
// Poll until complete
while (true) {
const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
if (pollResponse.status === 200) {
const data = await pollResponse.json();
// Process data.docContent (Base64 PDF)
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
エラー応答
の API 標準を返します HTTP エラーコードとエラー詳細:
- 無効なリクエストパラメータ
- 必須項目が欠落しています
- 無効 Base64 エンコーディング
docContent - 無効なバーコードタイプ
- 無効なアライメント値
- 無効または欠落 API 鍵
- API キーが正しくありません Base64 エンコードされた Authorization ヘッダー
- ない
Authorization: 基本ヘッダー
- サーバー側処理エラー
- PDF 処理エラー
- バーコード生成エラー
エラー応答フォーマット:
{
"error": "Error message describing what went wrong"
}
回答形式の詳細
重要: の API 常に返される JSON決してバイナリではない PDF データを直接取得します。
応答構造:
{
"docName": "string", // Output PDF filename
"docContent": "string" // Base64-encoded PDF content
}
Content-Type ヘッダー:
- 成功:
application/json - の PDF として埋め込まれています Base64 文字列内の JSON 応答
なぜ Base64?
- JSON-バイナリデータの安全なエンコード
- 簡単に伝達できます HTTP
- すべてのプログラミング言語に対応
- 直接埋め込むことができます JSON 問題から逃れることなく
デコード Base64 に PDF:
JavaScript/Node.js:
const base64 = response.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64').toString('binary'); // Node.js
Python:
import base64
pdf_bytes = base64.b64decode(response['docContent'])
with open('output.pdf', 'wb') as f:
f.write(pdf_bytes)
C#:
byte[] pdfBytes = Convert.FromBase64String(response.docContent);
File.WriteAllBytes("output.pdf", pdfBytes);
リクエスト例
ヘッダ
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
注記:
- 手に入れよう API 鍵から PDF4me ダッシュボード
- の API キーは Base64 エンコードされ、「Basic」がプレフィックスとして付加されています。 Authorization ヘッダー
- 例: API 重要なのは
abc123エンコードして Base64 そして使用するAuthorization: Basic YWJjMTIz
ペイロード
基本的な例(必須項目のみ):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"text": "PDF4me Barcode Sample",
"barcodeType": "qrCode",
"pages": "1-3",
"alignX": "Right",
"alignY": "Bottom",
"hideText": true
}
高度な例(すべてのオプションフィールドを含む):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"text": "PDF4me Barcode Sample",
"barcodeType": "qrCode",
"pages": "1-3",
"alignX": "Right",
"alignY": "Bottom",
"hideText": true,
"heightInMM": "40",
"widthInMM": "40",
"marginXInMM": "20",
"marginYInMM": "20",
"heightInPt": "113",
"widthInPt": "113",
"marginXInPt": "57",
"marginYInPt": "57",
"opacity": 100,
"displayText": "below",
"showOnlyInPrint": false,
"isTextAbove": false,
"async": true
}
コードサンプル
の PDF4me バーコードを追加する PDF REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。
- C#
- Java
- JavaScript
- Python
- Salesforce
- Google Script
- n8n
- AWS Lambda
業界におけるユースケースとアプリケーション
- E-commerce & Retail
- Logistics & Shipping
- Healthcare & Medical
- Government & Compliance
- Education & Libraries
- Business & Finance
Eコマースおよび小売業における活用事例
- 製品カタログ在庫管理および製品識別のためのバーコードを生成する
- 値札バーコード統合による動的な価格設定で自動チェックアウトを実現します
- 注文追跡リアルタイムで荷物を追跡できるよう、配送書類に追跡コードを追加する
- 在庫管理システム倉庫管理と在庫管理のためのバーコードの一括生成
物流・配送におけるユースケース
- 配送ラベル: 配送書類に追跡バーコードを追加して、荷物の追跡を可能にする
- 荷物追跡サプライチェーン全体を通して、各出荷物に対して固有の識別子を生成する。
- 倉庫管理: 保管場所と製品識別用のバーコードを作成する
- サプライチェーン埋め込みコードを使用して、流通ネットワーク全体で製品を追跡します。
ヘルスケアおよび医療分野における活用事例
- 患者記録患者の迅速な識別と病歴へのアクセスを可能にするバーコードを追加する
- 投薬管理薬剤追跡および投与量確認用のバーコードを生成する
- 医療機器資産管理のため、機器にメンテナンス用バーコードを付ける。
- 検査結果検査結果文書にバーコードを追加して、患者データの安全な連携を実現する
政府およびコンプライアンス関連のユースケース
- 身分証明書類運転免許証とパスポートにセキュリティバーコードを追加して認証を行う
- 税務書類税務申告書およびコンプライアンス監視用の追跡コードを生成する
- コンプライアンスフォーム規制追跡および監査証跡のためにバーコードを追加する
- 公文書政府データベース用の検索可能な文書識別子を作成する
教育・図書館における活用事例
- 学生証学生識別およびキャンパスアクセス制御用のバーコードを生成する
- 図書館システム自動チェックアウトシステム用に書籍や資料にバーコードを追加する
- 試験問題試験文書と学術的誠実性のための固有識別子を作成する
- キャンパスサービス教育施設全体における機器およびリソースの使用状況を追跡する
ビジネスおよび金融分野における活用事例
- 請求書処理請求書処理と支払い処理を自動化するためにバーコードを追加する
- 文書管理ビジネス文書や記録に固有の識別子を作成する
- 資産追跡組織全体の機器や資産のバーコードを生成する
- 監査証跡コンプライアンス文書および財務記録用の追跡コードを追加する