Documents

Générez des PDF conformes à partir de vos templates. Chaque document reçoit un numéro séquentiel, un QR code de vérification et une URL de téléchargement.

Générer un document

POST
/v1/documentsAPI Key

Générer un nouveau document PDF à partir d'un template.

Body
ParamètreTypeDescription
templateIdrequisstringID du template à utiliser
datarequisobjectDonnées à injecter dans les variables Handlebars du template
options.qrCodeoptionnelbooleanInclure un QR code de vérificationDéfaut : true
options.docNumberoptionnelstringNuméro de document personnalisé (sinon auto-généré)
options.webhookUrloptionnelstringURL de callback à notifier quand le document est prêt
Réponse201 Created
JSON
{
"id": "f7e8d9c0-b1a2-3456-7890-abcdef123456",
"template_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"doc_number": "FNE-2026-001847",
"type": "invoice",
"status": "completed",
"pdf_url": "https://cdn.restifydocs.com/docs/f7e8d9c0.pdf",
"verify_url": "https://verify.restifydocs.com/v/abc123",
"compliance": {
"country": "CI",
"standard": "FNE",
"valid": true
},
"generated_at": "2026-04-27T10:30:00.000Z"
}
Génération rapide
La génération prend typiquement moins de 300ms. Le statut passe directement à completed dans la plupart des cas.

Lister les documents

GET
/v1/documentsAPI Key

Récupérer la liste des documents générés.

Query params
ParamètreTypeDescription
searchoptionnelstringRechercher par numéro de document
template_idoptionnelstringFiltrer par template
typeoptionnelstringFiltrer par type (invoice, quote, receipt, credit_note, free)
statusoptionnelstringFiltrer par statut (completed, pending, rendering, failed)
pageoptionnelnumberNuméro de pageDéfaut : 1
per_pageoptionnelnumberÉléments par page (max 100)Défaut : 15
Réponse200 OK
JSON
{
"data": [
{
"id": "f7e8d9c0-...",
"docNumber": "FNE-2026-001847",
"type": "invoice",
"countryCode": "CI",
"templateVersion": 1,
"status": "completed",
"createdAt": "2026-04-27T10:30:00.000Z"
}
],
"pagination": {
"page": 1,
"perPage": 15,
"total": 42,
"totalPages": 3
}
}

Récupérer un document

GET
/v1/documents/:idAPI Key

Récupérer les détails complets d'un document.

Réponse200 OK
JSON
{
"id": "f7e8d9c0-...",
"template_id": "a1b2c3d4-...",
"doc_number": "FNE-2026-001847",
"type": "invoice",
"status": "completed",
"pdf_url": "https://cdn.restifydocs.com/docs/f7e8d9c0.pdf",
"verify_url": "https://verify.restifydocs.com/v/abc123",
"compliance": {
"country": "CI",
"standard": "FNE",
"valid": true
},
"generated_at": "2026-04-27T10:30:00.000Z"
}

Statuts

StatutDescription
completedLe PDF est généré et disponible au téléchargement.
pendingLe document est en file d'attente pour la génération.
renderingLe PDF est en cours de génération.
failedLa génération a échoué. Vérifiez vos données et le template.

Prochaine étape

Découvrez comment vérifier l'authenticité d'un document via QR code.

Vérification →