API PDF de relevé est-elle un endpoint séparé ?

Non. Cette page explique comment utiliser /api/v1/pdf/render et les API gPdf associées pour ce flux.

Que doit fournir mon système ?

Votre système fournit les données métier, le mapping, la validation et les règles avant rendu. gPdf prend en charge la génération PDF.

Quand utiliser Template Render ?

Utilisez Template Render lorsque la mise en page est stable et que les appelants doivent seulement envoyer template_id et data[].

Que vérifier avant la production ?

Testez les données réelles, cas limites, validations et systèmes aval qui lisent, impriment ou archivent le PDF.

Facturation et finance

API PDF de relevé pour finance et SaaS

API PDF de relevé : produire relevés périodiques et états de compte en PDF traçables, sans rendu navigateur et avec une frontière claire entre le rendu gPdf et vos données métier.

API PRINCIPALE JSON Render

ENDPOINT /api/v1/pdf/render

SYSTÈMES backend facturation / système de comptes / service export ERP / service reporting SaaS

Essayer dans le Playground Lire la documentation

Tâche à accomplir

produire relevés périodiques et états de compte en PDF traçables. Votre système fournit les données et règles ; gPdf les rend en PDF de manière reproductible.

Quand utiliser cette API

Votre système possède déjà les données nécessaires pour relevés et attend une réponse PDF.
Vous voulez utiliser JSON Render via /api/v1/pdf/render plutôt qu'un flux HTML vers PDF basé sur navigateur.
Mise en page, codes-barres, texte et métadonnées doivent être reproductibles depuis des données structurées.
Les payloads doivent pouvoir être testés dans le Playground ou en CI avant production.

Ce qu'elle ne remplace pas

Vous avez besoin d'une conversion HTML vers PDF arbitraire avec Chromium.
Vous attendez de gPdf qu'il déduise un sens métier ou légal depuis des données brutes.
Un contrat template_id publié serait plus adapté que l'envoi du layout à chaque requête.

Quel endpoint appeler

PRINCIPAL

/api/v1/pdf/render

JSON Render est le chemin par défaut pour ce flux.

SECONDAIRE 1

/api/v1/template-render

À utiliser si le flux a besoin d'un chemin API lié, d'un contrat de modèle ou d'une recherche de capacités.

Requête minimale

/api/v1/pdf/render - requête minimale pour relevés.

{
  "settings": {
    "profile": "pdfa-2b"
  },
  "pages": [
    {
      "size": "letter",
      "elements": [
        {
          "type": "text",
          "x": 18,
          "y": 20,
          "content": "Account Statement",
          "style": { "font_size": 18, "font_family": "NotoSans-Regular" }
        },
        {
          "type": "text",
          "x": 18,
          "y": 38,
          "content": "Period: 2026-05-01 to 2026-05-31\nOpening balance: $1,240.00\nClosing balance: $1,890.25",
          "style": { "font_size": 11, "font_family": "NotoSans-Regular" }
        }
      ]
    }
  ]
}

Ce que gPdf prend en charge

Rendu `DocumentRequest` pour les pages de relevé.
Pages PDF, texte, tableaux, lignes, formes, images et codes-barres vectoriels selon le besoin.
Sortie PDF déterministe pour réimpression, audit et automatisation backend.
Surface d'erreur API unifiée avec code API-XXX et req_id en cas d'échec.

Ce que votre système garde

Données métier, mapping des champs et sémantique du document.
Validation, idempotence, nommage, stockage et traçabilité après la réponse.
Règles fiscales, conformité, client ou plateforme avant le rendu.

Checklist de production

Ajouter request IDs et timeouts aux appels de production.
Valider les payloads avec OpenAPI, la documentation ou des tests Golden PDF.
Garder l'URL de base API et le bearer token configurables, hors du code source.
Tester les layouts critiques avec données réelles et cas limites.
Conserver les preuves de validation et de réimpression dans le système qui en a besoin.

Limites de la promesse

gPdf rend relevés ; l'exactitude métier reste dans votre système.
Cette page décrit le bon chemin d'API gPdf, pas un endpoint spécifique supplémentaire.
Certification externe, acceptation et validations opérationnelles restent hors du renderer.

Les relevés sont des documents de période

Un relevé doit partir d’un ensemble clos de faits métier : compte, période, solde d’ouverture, lignes d’activité, ajustements et solde de clôture. gPdf ne décide pas ces faits. Il les rend dans une mise en page PDF que vos utilisateurs peuvent télécharger ou que votre système peut stocker.

Gérer les grands volumes de lignes

Pour les relevés avec beaucoup de lignes, concevez le document comme une mise en page répétable avec zones de tableau, sections de synthèse et numéros de page. Utilisez JSON Render pendant l’ajustement de la mise en page. Passez à Template Render quand le contrat de champs est stable.

FAQ

API PDF de relevé est-elle un endpoint séparé ?: Non. Cette page explique comment utiliser /api/v1/pdf/render et les API gPdf associées pour ce flux.
Que doit fournir mon système ?: Votre système fournit les données métier, le mapping, la validation et les règles avant rendu. gPdf prend en charge la génération PDF.
Quand utiliser Template Render ?: Utilisez Template Render lorsque la mise en page est stable et que les appelants doivent seulement envoyer template_id et data[].
Que vérifier avant la production ?: Testez les données réelles, cas limites, validations et systèmes aval qui lisent, impriment ou archivent le PDF.