バーコードを作成する - QR Code ジェネレータ API
PDF4me バーコードを作成する スタンドアロンのバーコードを作成でき、 QR code 150種類以上のバーコードタイプをサポートする画像 QR codes、 Code128、 DataMatrix、 Aztec、 Hanxin、 PDF417、および特殊なフォーマット。 API このサービスは、印刷、モバイルスキャン、デジタルアプリケーション向けに最適化された準拠バーコード画像を生成します。 API テキストデータとバーコードパラメータを受信 REST API 通話を利用して Base64 安全なデータ送信のためのエンコード機能。このソリューションは、在庫管理システム、製品ラベルの自動化、および企業向けバーコード生成ワークフローに最適です。
認証 API リクエスト
アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。
主な機能
- 包括的なバーコードライブラリ: 150種類以上のバーコードタイプを含む QR codes、 Code128、 DataMatrix、 Aztec、 Hanxin、 PDF417郵便番号、およびバーコードタイプパラメータを使用した特殊な業界シンボル
- スタンドアロン画像生成ファイル名指定により、既存の文書やテンプレートを必要とせずに、高品質のバーコード画像を独自に作成できます。
- 高度なテキスト管理テキストパラメータを使用して、プロフェッショナルな書式設定オプションでバーコードのテキスト表示、位置、および可視性を設定し、見やすいプレゼンテーションを実現します。
- エンタープライズ統合: 単純 API 既存のビジネスシステムやワークフローへのシームレスな統合を目的とした最小限のパラメータと適切なパラメータマッピングを備えています。
REST API 終点
の PDF4me REST API 標準を使用する HTTP リソースとやり取りするための方法。すべてのバーコード生成操作は、単一のエンドポイントを介して実行されます。
- 方法: POST
- 終点:
/api/v2/CreateBarcode
サポートされているバーコードの種類
150種類以上のバーコードタイプをサポートし、包括的なバーコード生成を実現します。 JSON 仕様。
人気の1次元バーコード
- Code128 - バーコードタイプパラメータを使用したユニバーサルバーコード(最大255文字)
- Code39 - テキストパラメータによる英数字バーコード(最大43文字)
- EAN13/EAN8 - ファイル名指定付きの小売製品コード(13/8文字)
- UPC-A/UPC-E - 北米小売(12/8文字) API 統合
人気の2次元バーコード
- QR Code - バーコードタイプパラメータを使用したモバイルスキャン(最大4,296文字)
- DataMatrix - テキストパラメータによる高密度2D(最大2,335文字)
- PDF417 - ファイル名指定による大容量データ(最大2,710文字)
- Aztec - 優れたエラー訂正機能 (最大 3,832 文字) API 統合
特殊フォーマット
- 郵便番号: USPS、 Royal Mail、 Australia Post、 Deutsche Post バーコードタイプパラメータを使用する
- 健康管理: HIBC、 GS1 DataBar、 Pharmacode テキストパラメータを介して
- ロジスティクス: MaxiCode、 SSCC-18、 ITF-14、 GS1-128 ファイル名指定付き
- QRコードのバリエーション: Micro QR、 iQR、 rMQR 使用 API 統合
REST API パラメータ
バーコード作成のパラメータ一覧 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 |
| barcodeType | Optional | An unrecognised value is rejected with 400. Type: string. | qrCode |
| text | Optional | Required. The value to encode in the barcode. Type: string. | PDF4me Create Barcode Sample |
| hideText | Optional | Hide the human-readable text of the barcode. Type: boolean. | false |
出力
の PDF4me バーコードを作成する REST API 処理モードに基づいて異なる応答を返します。 API バーコードを バイナリイメージファイル(PNG フォーマット)それほどではない JSON。
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
同期処理(デフォルト)
いつ async 設定されていないか、 false、 API リクエストを即座に処理します。
ステータスコード: 200 OK
Content-Type: image/png (または適切な画像形式)
応答本文: レスポンスボディには、バーコード画像がバイナリデータとして含まれています(PNG デフォルトではフォーマットされています。
使用方法:
- レスポンスボディをバイナリデータとして読み込む
- バイナリデータを画像ファイル(例:.png、.jpg)として保存します。
- 必要に応じて画像ファイルを使用してください
例 (JavaScript):
const response = await fetch(url, options);
const blob = await response.blob();
const url = URL.createObjectURL(blob);
// Use the URL to display or download the image
例 (Python):
response = requests.post(url, json=payload, headers=headers)
if response.status_code == 200:
with open('barcode.png', 'wb') as f:
f.write(response.content)
非同期処理
いつ async: true 設定されている、 API リクエストを非同期的に処理します。
ステータスコード: 202 Accepted
レスポンスヘッダー:
Location: https://api.pdf4me.com/api/v2/CreateBarcode/poll/12345-abcde-67890
投票プロセス:
- 抽出する
Location202レスポンスのヘッダー - 投票する URL 使用 GET リクエスト
- 受信するまで投票を続けてください 200 OK 状態
- 最終応答には、バイナリデータとしてのバーコード画像が含まれます(PNG フォーマット)
投票例:
// 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 blob = await pollResponse.blob();
// Process blob (barcode image)
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
エラー応答
の API 標準を返します HTTP エラーコードとエラー詳細:
- 無効なリクエストパラメータ
- 必須項目が欠落しています(
文章、バーコードタイプ、テキストを隠す、非同期) - 無効なバーコードタイプ
- テキストの長さがバーコードタイプの容量を超えています
- 無効または欠落 API 鍵
- API キーが正しくありません Base64 エンコードされた Authorization ヘッダー
- ない
Authorization: 基本ヘッダー
- サーバー側処理エラー
- バーコード生成エラー
エラー応答フォーマット:
{
"error": "Error message describing what went wrong"
}
回答形式の詳細
重要: の API バイナリ画像データを返します(PNG デフォルトのフォーマットではない JSON。
応答構造:
- Content-Type:
image/png(または適切な画像MIMEタイプ) - 応答本文バイナリ画像データ
画像フォーマット:
- デフォルト形式: PNG
- バーコード画像は、直接使用、ダウンロード、または統合できる状態です。
画像の保存:
JavaScript/Node.js:
const response = await fetch(url, options);
const blob = await response.blob();
const url = URL.createObjectURL(blob);
const a = document.createElement('a');
a.href = url;
a.download = 'barcode.png';
a.click();
Python:
response = requests.post(url, json=payload, headers=headers)
if response.status_code == 200:
with open('barcode.png', 'wb') as f:
f.write(response.content)
C#:
var response = await httpClient.PostAsync(url, content);
if (response.IsSuccessStatusCode)
{
var imageBytes = await response.Content.ReadAsByteArrayAsync();
await File.WriteAllBytesAsync("barcode.png", imageBytes);
}
リクエスト例
ヘッダ
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
注記:
- 手に入れよう API 鍵から PDF4me ダッシュボード
- の API キーは Base64 エンコードされ、「Basic」がプレフィックスとして付加されています。 Authorization ヘッダー
- 例: API 重要なのは
abc123エンコードして Base64 そして使用するAuthorization: Basic YWJjMTIz
ペイロード
例:
{
"text": "PDF4me Create Barcode Sample",
"barcodeType": "qrCode",
"hideText": false,
"async": true
}
コードサンプル
の PDF4me バーコードを作成する REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
業界におけるユースケースとアプリケーション
- E-commerce & Retail
- Logistics & Shipping
- Healthcare & Medical
- Government & Compliance
- Education & Libraries
- Business & Finance
Eコマースおよび小売業における活用事例
- 製品ラベル: バーコードタイプパラメータを使用して、製品パッケージとラベル用のスタンドアロンバーコード画像を生成します
- 値札テキストパラメータを使用して、動的価格設定および自動チェックアウトシステム用のバーコード画像を作成します。
- 在庫管理: ファイル名を指定して倉庫管理および在庫管理用のバーコード画像を生成します。
- 製品カタログ製品識別およびカタログシステム用のバーコード画像を作成する API 統合
物流・配送におけるユースケース
- 配送ラベル: バーコードタイプパラメータを使用して、パッケージの追跡と配送用のスタンドアロンバーコード画像を生成します
- パッケージ識別テキストパラメータを使用して、サプライチェーン全体で各出荷ごとに固有のバーコード画像を作成します。
- 倉庫システムファイル名を指定して、保管場所と在庫追跡用のバーコード画像を生成します。
- サプライチェーン: 流通ネットワークを通じた製品追跡用のバーコード画像を作成する API 統合
ヘルスケアおよび医療分野における活用事例
- 患者識別: バーコードタイプパラメータを使用して、患者のリストバンドと医療記録用のバーコード画像を生成します。
- 服薬状況の追跡: テキストパラメータを使用して、薬剤識別および投与量検証用のバーコード画像を作成します。
- 機器管理: ファイル名を指定して医療機器および資産追跡用のバーコード画像を生成する
- 検査サンプル追跡: 試験サンプルと結果識別用のバーコード画像を作成する API 統合
政府およびコンプライアンス関連のユースケース
- 身分証明書類バーコードタイプパラメータを使用して、運転免許証、パスポート、身分証明書のバーコード画像を生成します。
- フォーム処理: テキストパラメータを使用して、税務申告書やコンプライアンス文書用のバーコード画像を作成します。
- 文書追跡: ファイル名指定による規制追跡および監査証跡用のバーコード画像を生成する
- 公文書: 政府文書識別システム用のバーコード画像を作成する API 統合
教育・図書館における活用事例
- 学生証バーコードタイプパラメータを使用して、学生識別およびキャンパスアクセス用のバーコード画像を生成します。
- 図書館システムテキストパラメータを使用して、書籍識別および貸出システム用のバーコード画像を作成します。
- 試験のセキュリティ: ファイル名指定によるテスト文書の識別と整合性のためのバーコード画像を生成する
- キャンパスサービス: 機器やリソースの追跡用のバーコード画像を作成する API 統合
ビジネスおよび金融分野における活用事例
- 請求書システムバーコードタイプパラメータを使用して、自動請求書処理および支払い用のバーコード画像を生成します。
- 文書管理: テキストパラメータを使用して、ビジネス文書識別用のバーコード画像を作成します。
- 資産追跡: ファイル名を指定して、機器および資産管理システム用のバーコード画像を生成します。
- コンプライアンス文書: 監査証跡と財務記録用のバーコード画像を作成する API 統合