Aller au contenu
Thème
Français

API Factur-X et ZUGFeRD

Transformez une facture UBL, CII ou XRechnung en PDF/A-3 Factur-X en un appel REST. Facturé seulement si le fichier est valide. Traité pour la requête.

Cette fonction est en bêta : elle fonctionne et elle est testée, mais des détails peuvent encore changer.

Sur cette page

L’API Factur-X et ZUGFeRD de Klarbon transforme une facture UBL, CII ou XRechnung en PDF/A-3 hybride : une facture lisible qui contient les données CII structurées. Un appel REST renvoie le PDF et son rapport de validation, et vous n’êtes facturé que si les règles de la facture et un contrôle PDF/A indépendant sont tous deux réussis. Les fichiers sont traités pour la requête, sans archive de documents.

Ce que fait l’API

  • POST /api/v1/convert avec target=factur-x ou target=zugferd produit le PDF, au profil EN 16931 sauf si vous en demandez un autre.
  • POST /api/v1/make crée le même PDF à partir de données JSON.
  • Le rapport indique le jeu de règles, le profil, le nom du fichier XML intégré et le résultat PDF/A.

Ce qu’elle ne fait pas

La production de Factur-X est en bêta : elle fonctionne et elle est testée, mais des détails peuvent encore changer. Klarbon n’est pas une plateforme agréée et ne transmet aucune facture. Pour les factures françaises concernées par la réforme, utilisez une plateforme agréée et confirmez les formats et profils acceptés par le destinataire.

Démarrage rapide

Chaque exemple fait le même appel. Avant publication, chacun est exécuté contre un serveur Klarbon local et le vrai moteur de validation.

Créez une clé sur la page de votre compte et placez-la dans KLARBON_API_KEY. Ne la mettez jamais dans l’adresse.

POST /api/v1/convert

curl + jq
curl -sS https://klarbon.app/api/v1/convert \
  -H "Authorization: Bearer $KLARBON_API_KEY" \
  -H "Idempotency-Key: invoice-123456XX-factur-x" \
  -F "file=@invoice.xml;type=application/xml" \
  -F target=factur-x \
  -o result.json
jq -e '.ok' result.json > /dev/null || { jq -r '.error + ": " + .message' result.json; exit 1; }
jq -r '.file.content' result.json | base64 --decode > "$(jq -r '.file.filename' result.json)"
TypeScript, Node.js 22.18+
import { readFile, writeFile } from "node:fs/promises"

type KlarbonFile = { content: string; filename: string; mime: string; bytes: number }
type Failure = { ok: false; error: string; message: string }
type Converted = { ok: true; file: KlarbonFile; credits: { spent: number; balance: number } }

const form = new FormData()
form.append("file", new Blob([await readFile("invoice.xml")], { type: "application/xml" }), "invoice.xml")
form.append("target", "factur-x")

const response = await fetch("https://klarbon.app/api/v1/convert", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.KLARBON_API_KEY}`,
    "Idempotency-Key": "invoice-123456XX-factur-x",
  },
  body: form,
})
const result = (await response.json()) as Converted | Failure
if (!result.ok) throw new Error(`${response.status} ${result.error}: ${result.message}`)
await writeFile(result.file.filename, Buffer.from(result.file.content, "base64"))
console.log(`${result.file.filename} written, ${result.credits.balance} credits left`)
Python 3.9+, requests
import base64
import os

import requests

with open("invoice.xml", "rb") as upload:
    response = requests.post(
        "https://klarbon.app/api/v1/convert",
        headers={
            "Authorization": f"Bearer {os.environ['KLARBON_API_KEY']}",
            "Idempotency-Key": "invoice-123456XX-factur-x",
        },
        files={"file": ("invoice.xml", upload, "application/xml")},
        data={"target": "factur-x"},
        timeout=120,
    )
result = response.json()
if not result["ok"]:
    raise SystemExit(f"{response.status_code} {result['error']}: {result['message']}")
with open(result["file"]["filename"], "wb") as output:
    output.write(base64.b64decode(result["file"]["content"]))
print(result["file"]["filename"], "written,", result["credits"]["balance"], "credits left")
PHP 8+, curl
<?php
$curl = curl_init('https://klarbon.app/api/v1/convert');
curl_setopt_array($curl, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 120,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('KLARBON_API_KEY'),
        'Idempotency-Key: invoice-123456XX-factur-x',
    ],
    CURLOPT_POSTFIELDS => [
        'file' => new CURLFile('invoice.xml', 'application/xml', 'invoice.xml'),
        'target' => 'factur-x',
    ],
]);
$body = curl_exec($curl);
if ($body === false) {
    fwrite(STDERR, curl_error($curl) . "\n");
    exit(1);
}
$result = json_decode($body, true);
if (!$result['ok']) {
    $status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
    fwrite(STDERR, "$status {$result['error']}: {$result['message']}\n");
    exit(1);
}
file_put_contents($result['file']['filename'], base64_decode($result['file']['content']));
echo "{$result['file']['filename']} written, {$result['credits']['balance']} credits left\n";
C#, .NET 10
using System.Net.Http.Headers;
using System.Text.Json;

using var http = new HttpClient();
var key = Environment.GetEnvironmentVariable("KLARBON_API_KEY");
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", key);

var upload = new ByteArrayContent(await File.ReadAllBytesAsync("invoice.xml"));
upload.Headers.ContentType = new MediaTypeHeaderValue("application/xml");

using var request = new HttpRequestMessage(HttpMethod.Post, "https://klarbon.app/api/v1/convert?target=factur-x") { Content = upload };
request.Headers.Add("Idempotency-Key", "invoice-123456XX-factur-x");
using var response = await http.SendAsync(request);
using var json = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
var result = json.RootElement;
if (!result.GetProperty("ok").GetBoolean())
{
    Console.Error.WriteLine($"{(int)response.StatusCode} {result.GetProperty("error")}: {result.GetProperty("message")}");
    return 1;
}
var written = result.GetProperty("file");
await File.WriteAllBytesAsync(written.GetProperty("filename").GetString()!,
    Convert.FromBase64String(written.GetProperty("content").GetString()!));
Console.WriteLine($"{written.GetProperty("filename")} written, {result.GetProperty("credits").GetProperty("balance")} credits left");
return 0;

La réponse

La réponse à l’appel curl ci-dessus, enregistrée lors de cette exécution avec KoSIT XRechnung test suite, business case 01.01a (UBL), Apache-2.0.

Raccourci pour la page: file.content: base64 cut

{
  "ok": true,
  "file": {
    "content": "JVBERi0xLjcKJfbk/N8KMjggMCBvYmoKPDwKL1R5cGUgL0Nh...",
    "filename": "123456XX-factur-x.pdf",
    "mime": "application/pdf",
    "bytes": 32690
  },
  "report": {
    "detected": {
      "syntax": "cii",
      "customizationId": "urn:cen.eu:en16931:2017",
      "profile": "en16931",
      "container": "pdf"
    },
    "ruleset": {
      "id": "facturx-1.09-en16931",
      "name": "Factur-X en16931",
      "version": "1.0.9-2"
    },
    "valid": true,
    "pdf": {
      "pdfa": {
        "conforms": true,
        "part": 3,
        "conformance": "B",
        "findings": []
      },
      "xmlFilename": "factur-x.xml",
      "profile": "en16931"
    },
    "engineVersion": "1.0.0",
    "durationMs": 97,
    "findings": [
      {
        "ruleId": "PEPPOL-EN16931-R008",
        "severity": "warning",
        "message": "[PEPPOL-EN16931-R008]-Document MUST not contain empty elements. (still status warning)",
        "location": "/rsm:CrossIndustryInvoice[1]/rsm:SupplyChainTradeTransaction[1]/ram:ApplicableHeaderTradeDelivery[1]",
        "test": "false",
        "title": "PEPPOL-EN16931-R008",
        "what": "[PEPPOL-EN16931-R008]-Document MUST not contain empty elements. (still status warning)",
        "fix": "",
        "link": null,
        "officialUrl": null
      }
    ]
  },
  "losses": [
    {
      "kind": "changed",
      "path": "specificationId"
    }
  ],
  "credits": {
    "spent": 1,
    "balance": 198,
    "plan": 0,
    "bought": 198
  }
}

Tarifs

Des packs API prépayés, achetés par carte sur la page de votre compte : 1 000 appels pour 39,00 €, 5 000 appels pour 129,00 €, 25 000 appels pour 449,00 €, 100 000 appels pour 990,00 €, sans date d’expiration. Votre première clé apporte 25 appels gratuits. Les appels payants consomment d’abord le solde API, puis les mêmes crédits que le site. Un appel qui échoue ne coûte rien.

Appel Coût
POST /open Gratuit, usage raisonnable jusqu’à 1 000 par jour et par compte
POST /check Gratuit dans la limite quotidienne de votre offre (20 par jour avec l’offre gratuite)
POST /convert, POST /make 1 appel, seulement si le fichier produit est valide
POST /bank/convert 1 appel par tranche entamée de 500 opérations, seulement après conversion

Limites

  • Fichiers jusqu’à 20 Mo, PDF jusqu’à 50 pages.
  • 60 requêtes par minute et par clé, 120 par compte. Une réponse 429 indique Retry-After.
  • Jusqu’à 10 clés par compte. Idempotency-Key est respecté pendant 24 heures : une nouvelle tentative n’est jamais facturée deux fois.

Erreurs

Chaque erreur a la forme { ok: false, error, message } : un code stable et une phrase claire.

Statut Code Quand
401 auth Aucune clé, ou une clé inconnue ou révoquée.
402 no_credits Solde API et crédits tous deux insuffisants. Rien n’a été fait ; topUpUrl indique où en acheter.
413 too_large Plus de 20 Mo ou de 50 pages PDF.
415 unsupported Un format de fichier que la route n’accepte pas.
422 invalid Le fichier est illisible, ou le fichier produit n’est pas valide. Non facturé.
429 limit Une limite de débit, ou les appels gratuits du jour.
503 engine_unavailable La validation est brièvement indisponible. Non facturé.

Confidentialité

Les fichiers sont traités pour la requête, sans archive de documents. Les journaux de l'application Klarbon ne contiennent ni nom de fichier, ni contenu, ni clé. La clé complète n'est pas conservée, seulement son empreinte HMAC et un court préfixe d'affichage.

Pour aller plus loin

La documentation pour les développeurs est en anglais.

Questions fréquentes

Factur-X et ZUGFeRD sont-ils identiques ?

Leurs versions harmonisées sont techniquement identiques. Klarbon utilise le même outil de production de PDF hybride pour les deux cibles. Demandez au destinataire les versions et profils acceptés.

Quel profil Factur-X l’API produit-elle ?

EN 16931 par défaut. Le paramètre profile en choisit un autre lorsque le format le permet, et le rapport indique le profil produit.

Le PDF est-il contrôlé en PDF/A-3 ?

Oui. Le fichier n’est proposé que si le contrôle du PDF terminé a réussi ; sinon l’appel répond 422 et rien n’est facturé.

Klarbon transmet-il mes factures à une plateforme agréée ?

Non. Klarbon crée et contrôle le fichier ; la transmission passe par votre plateforme agréée.

Puis-je créer une Factur-X à partir de mes données ?

Oui. La route make accepte les données de la facture en JSON et renvoie le même PDF contrôlé.

Sources

Mis à jour le 5 novembre 2026