Guide du produit et de l’API

Liens d’aperçu

Paramètres de la visionneuse et de l’intégration

Configurez l’apparence, la visibilité du titre et la navigation dans les paramètres de la visionneuse intégrée du compte. Le retrait de marque et l’intégration dépendent de l’offre ; vérifiez leur disponibilité dans le panneau.

Sites autorisés

Ajoutez les sites d’intégration de la visionneuse aux sites autorisés. L’autorisation d’intégration et la validité du partage sont distinctes : autoriser un site ne réactive pas un partage expiré ou révoqué. Ne mettez jamais de clé API dans le code du navigateur ou l’URL d’un iframe.

Vérifiez avant de partager

Testez le lien dans les conditions du destinataire. Vérifiez le nombre de pages, les graphiques et tableaux, les formats de téléchargement et l’expiration. Testez aussi l’intégration sur un site non autorisé ; un aperçu fonctionnel dans le compte ne prouve pas que l’accès externe est activé.

Crée un lien de consultation temporaire que votre client peut ouvrir sans compte. Un seul appel peut renvoyer les liens de téléchargement PDF et DOCX.

Demande 
curl -X POST https://api.pdfgine.com/api/v1/preview \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "templateCode": "invoice", "formats": ["pdf", "docx"], "data": { } }'
Réponse 
{
  "previewId": "prv_481fac83d9f14a4493021eb128d0876b",
  "previewUrl": "/p/prv_481fac83d9f14a4493021eb128d0876b",
  "expiresAt": "2026-08-29T13:23:43+00:00",
  "pageCount": 1,
  "downloads": [
    { "format": "pdf", "downloadUrl": "/api/v1/previews/prv_481f.../download/pdf?expires=...&token=..." },
    { "format": "docx", "downloadUrl": "/api/v1/previews/prv_481f.../download/docx?expires=...&token=..." }
  ]
}

Le lien comporte une signature impossible à deviner et se ferme à expiresAt.

Durée de disponibilité des documents

PDFgine génère et livre les documents ; leur conservation vous appartient. Le produit conserve uniquement ses entrées (modèles, ressources de marque) et des sorties temporaires. Chaque sortie reste pendant la durée choisie dans la requête : accessProfile: short 24 heures (par défaut), standard 7 jours, extended 30 jours (7 et 30 jours à partir de Go), quarter 90 jours (Max). Un lien partagé reste ouvert pendant ce délai ; un document de production (/render, /documents/render) peut être téléchargé à nouveau via l’API durant cette période. À l’échéance, les téléchargements répondent 410 et la sortie est supprimée sous 24 heures ; l’enregistrement de génération, le nombre de pages et les données d’utilisation restent conservés. Pour conserver un document définitivement, stockez-le dans votre système immédiatement après sa génération.

Liens de quatre-vingt-dix jours

À côté des profils standard et extended, le profil quarter maintient un lien actif pendant 90 jours, pour un contrat que l’autre partie doit pouvoir rouvrir durant un trimestre entier. Il est disponible avec l’offre la plus élevée ; chaque offre affiche les profils qu’elle autorise dans ses droits.

Fermer un lien avant son échéance

Un lien de partage se ferme normalement à expiresAt. Si le document ne doit plus être consulté, révoquez-le : la réponse est 204 et le lien cesse immédiatement de fonctionner.

cURL 
curl -i -X POST https://api.pdfgine.com/api/v1/previews/prv_481fac83d9f14a4493021eb128d0876b/revoke \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

HTTP/1.1 204 No Content

Les problèmes les plus courants

  • La création d’un aperçu répond 201, pas 200, et sa révocation répond 204 sans corps. Un client qui analyse chaque réponse comme du JSON échoue lors de la révocation.
  • accessProfile détermine la durée du lien, et les profils plus longs nécessitent l’offre adaptée. Demander quarter avec une offre qui ne l’inclut pas est refusé, pas raccourci silencieusement.
  • Les liens de téléchargement dans downloads comportent une signature et une échéance. Stockez previewId, pas ces adresses ; une adresse stockée cesse de fonctionner à son expiration.
  • La révocation ferme le lien, pas le document. Le fichier reste le vôtre et peut être téléchargé via l’API jusqu’à la fin de sa conservation.
  • Un aperçu consomme des pages d’aperçu, pas le quota de production. Produire à nouveau le même document avec /render entraîne un nouveau décompte de pages facturables.