Diviser PDF par code-barres API
Fonctionnement de ce point de terminaison : Le PDF4me Diviser PDF par code-barres REST API scanne un PDF Ce document est divisé en pages contenant une valeur de code-barres spécifique, puis indexé à chaque page correspondante. chaîne de code-barres, méthode de filtrage et type de code-barres, puis choisissez si vous souhaitez couper avant, après ou en retirant la page du code-barres. API utilise des configurables DPI Ce système de rendu assure une reconnaissance fiable des codes-barres quelle que soit la qualité d'impression et permet, en option, de regrouper les pages consécutives comportant le même code-barres dans une seule section de sortie. Il est idéal pour le traitement automatisé des factures, le tri du courrier, le traitement par lots de documents et tout flux de travail utilisant les codes-barres comme séparateurs physiques de documents.
Authentification de votre API Demande
Chaque PDF4me REST API L'appel doit inclure votre API clé dans le Authorization En-tête. Obtenez votre clé depuis le tableau de bord développeur.
Informations importantes à ne pas manquer
DocName, DocContent, Barcode String, Barcode Filter, Barcode Type, Split Barcode Page, Combine Pages With Same Consecutive Barcodes, and Pdf Render Dpi are all required. Omitting any parameter causes the API to return an error or produce unexpected split results. Validate all eight fields before sending the request.
The API uses Barcode Type to select the correct recognition engine. Setting Code128 when the document contains QR Codes causes recognition to fail silently: the API returns the unsplit original document because no barcodes matched. Always verify the barcode format used in your documents before setting this parameter.
The API renders each page at the specified DPI before scanning for barcodes. At low DPI (e.g. 150), small or dense barcodes: such as DataMatrix or compact QR codes on A4 pages, may not resolve clearly enough for accurate decoding. Use 300 DPI as your default. Increase to 400-600 DPI only for very small barcodes; higher values increase processing time significantly.
REST API Point de terminaison
| Méthode | Point de terminaison |
|---|---|
| POST | /api/v2/SplitPdfByBarcode_old |
URL de base : https://api.pdf4me.com
Paramètres
⚠️ Les huit paramètres sont tous requis. pour une détection et un comportement de séparation corrects des codes-barres.
| Paramètre | Requis | Taper | Ce que cela fait | Exemple |
|---|---|---|---|---|
| DocName | Required | String | Filename of the source PDF including the .pdf extension. Used for processing identification and output file naming. | batch-invoices.pdf |
| DocContent | Required | Base64 | The complete PDF file encoded as a Base64 string. The PDF must contain pages with machine-readable barcodes. | JVBERi0xLjQK... |
| Barcode String | Required | String | The barcode text or pattern to search for. Matched against decoded barcode values on each page using the Barcode Filter method. | INV- |
| Barcode Filter | Required | Enum | How the Barcode String is matched against decoded barcode text. Contains: text includes the string anywhere. Equals, exact match. StartsWith, text begins with the string. EndsWith, text ends with the string. | Contains |
| Barcode Type | Required | String | The barcode format printed in the PDF. Must match the actual barcode standard used. Common values: Code128 · Code39 · QRCode · EAN13 · EAN8 · DataMatrix · PDF417 | Code128 |
| Split Barcode Page | Required | Enum | Controls where the split occurs relative to the barcode page. Before: barcode page starts the next document. After, barcode page ends the current document. Remove, barcode page is excluded from all output. | After |
| Combine Pages With Same Consecutive Barcodes | Required | Boolean | When true, consecutive pages sharing the same barcode value are grouped into a single output document rather than split individually. Useful for multi-page forms where the same barcode appears on every page of a section. | true |
| Pdf Render Dpi | Required | String | DPI resolution for rendering PDF pages before barcode scanning. 300 is recommended for standard-size barcodes. Increase to 400-600 for small or dense barcodes. Higher DPI improves recognition accuracy but increases processing time. | 300 |
Champs de sortie
| Champ | Taper | Description |
|---|---|---|
| Contenu du fichier | Base64 | La répartition de la sortie PDF contenu encodé comme Base64Décodez-le en binaire pour enregistrer le fichier. |
| Nom de fichier | String | Nom du fichier de sortie divisé PDF. |
Exemple de requête
En-têtes
Content-Type: application/json
Authorization: YOUR_API_KEY
JSON charge utile
{
"DocName": "batch-invoices.pdf",
"DocContent": "JVBERi0xLjQK...",
"Barcode String": "INV-",
"Barcode Filter": "Contains",
"Barcode Type": "Code128",
"Split Barcode Page": "After",
"Combine Pages With Same Consecutive Barcodes": true,
"Pdf Render Dpi": "300"
}
Réponse
{
"File Content": "BASE64_SPLIT_PDF_CONTENT",
"File Name": "batch-invoices-split.pdf"
}
Exemples de code
Cas d'utilisation courants
Accounts payable teams receive consolidated PDF batches where each invoice has a Code128 barcode separator page. Split at each barcode (Split Barcode Page: Remove) to extract individual invoice PDFs for routing to the correct cost centre or approval queue automatically.
Bulk print mail runs produce a single PDF with a barcode cover sheet per recipient. Split the document at each barcode page (Split Barcode Page: After) to extract individual mail pieces. Use the barcode value (address or route code) to name each split file for downstream sorting and physical printing.
Scanned document batches from physical mailrooms often include a QR code separator sheet between each document. Set Barcode Type: QRCode, Barcode Filter: Contains the archive category code, and Split Barcode Page: Remove to get clean content-only PDFs ready for archiving: with no separator stubs included.
Foire aux questions
▶ What barcode types does the Split PDF by Barcode API support?
The API supports common 1D and 2D formats including Code128, Code39, QR Code, EAN-13, EAN-8, DataMatrix, and PDF417. Specify the correct type in Barcode Type: using the wrong type causes the recognition engine to miss all barcodes and return the unsplit original document.
▶ What does the Barcode Filter parameter control?
Barcode Filter controls how Barcode String is matched against decoded barcode text on each page. Contains: barcode text includes the string anywhere. Equals, exact match only. StartsWith, text begins with the string. EndsWith, text ends with the string. Use Contains for partial patterns, Equals for strict control over exact barcode values.
▶ What does Split Barcode Page control?
Split Barcode Page determines what happens to the page containing the matching barcode. Before: that page starts the next output document. After, that page ends the current output document. Remove, that page is excluded from all output documents entirely. Use Remove for blank separator pages or cover sheets you do not want in any output.
▶ What does Combine Pages With Same Consecutive Barcodes do?
When set to true, consecutive pages sharing the same barcode value are grouped into one output document instead of being split individually. This is useful for multi-page records or forms where the same barcode appears on every page of a section: it prevents unnecessary splits within a single logical document.
▶ Why should I increase Pdf Render Dpi for small or dense barcodes?
The API renders each PDF page at the specified DPI before scanning. At 150 DPI, small barcodes (e.g. DataMatrix cells under 5mm wide) may not resolve with enough pixel density for accurate decoding. Use 300 DPI as your default. Increase to 400-600 DPI for very small or dense barcodes: note that higher DPI significantly increases processing time and memory usage.