API REST

Documentation API

Integrez le tamponnage PDF dans vos applications avec notre API REST simple et puissante

Demarrage rapide

Commencez a utiliser l'API en 3 etapes simples

Creez un compte

Inscrivez-vous gratuitement et recevez 10 credits

Generez une cle API

Depuis votre dashboard, creez une cle API securisee

Faites votre premier appel

Utilisez l'API pour tamponner vos PDFs

Authentification

Toutes les requetes API necessitent une cle d'authentification

Obtenir une cle API

Connectez-vous a votre compte HelloStampPdf
Accedez a la section "Cles API"
Cliquez sur "Creer une cle API"
Donnez un nom a votre cle et copiez-la (elle n'est affichee qu'une fois)

Header d'authentification requis

Authorization: Bearer YOUR_API_KEY

Securite

Ne partagez jamais votre cle API. Stockez-la de maniere securisee dans vos variables d'environnement.

POST

/api/v1/stamp

Tamponner un ou plusieurs PDFs avec configuration personnalisee

Parametres (multipart/form-data)

Requisfiles

Un ou plusieurs fichiers PDF (maximum 20 fichiers, 50MB chacun)

Requisconfig(JSON string)

Configuration du tampon

{
  "shape": "RECTANGLE",        // ROUND, SQUARE, RECTANGLE
  "position": "TOP_RIGHT",     // Voir positions ci-dessous
  "topText": "PIECE N°",       // Texte superieur
  "bottomText": "Dossier X",   // Texte inferieur (optionnel)
  "fontSize": 12,              // 6-24
  "color": "#000000",          // Couleur texte (hex)
  "startNumber": 1,            // Numero de depart
  "width": 120,                // 50-300 points
  "height": 60,                // 30-200 points
  "marginX": 20,               // 0-100 points
  "marginY": 20,               // 0-100 points
  "borderWidth": 2,            // 0-10 points
  "borderColor": "#000000",    // Couleur bordure (hex)
  "stampEffect": false         // Effet tampon (true/false)
}

Positions disponibles :

TOP_LEFT

TOP_CENTER

TOP_RIGHT

CENTER_LEFT

CENTER

CENTER_RIGHT

BOTTOM_LEFT

BOTTOM_CENTER

BOTTOM_RIGHT

OptionneloutputType

MERGED (defaut) ou SEPARATE

OptionnelincludeBordereau

true ou false (defaut: false)

OptionnelcaseTitle

Titre du dossier pour le bordereau

Exemple curl

curl -X POST https://hellostamppdf.com/api/v1/stamp \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "files=@document1.pdf" \
  -F "files=@document2.pdf" \
  -F 'config={"shape":"RECTANGLE","position":"TOP_RIGHT","topText":"PIECE N°","bottomText":"Affaire Martin","fontSize":12,"color":"#000000","startNumber":1,"width":120,"height":60,"marginX":20,"marginY":20,"borderWidth":2,"borderColor":"#000000","stampEffect":false}' \
  -F "outputType=MERGED" \
  -F "includeBordereau=true" \
  -F "caseTitle=Dossier Martin c/ Dupont"

Reponse (200 OK)

{
  "success": true,
  "jobId": "clxxx...",
  "totalPages": 10,
  "creditsUsed": 11,
  "creditsRemaining": 89,
  "processingTime": 1234,
  "files": [
    {
      "name": "stamped_merged.pdf",
      "data": "base64_encoded_pdf..."
    }
  ]
}

Options de sortie et bordereau

Choisissez comment recevoir vos PDFs tamponnes et si vous souhaitez le bordereau recapitulatif

MERGEDPDF fusionne

Tous les PDFs tamponnes sont fusionnes en un seul fichier

✓ 1 seul fichier a telecharger

✓ Ideal pour l'archivage

✓ Pret pour l'impression

SEPARATEPDFs separes

Chaque piece est retournee dans un fichier PDF separe

✓ Fichiers individuels

✓ Noms de fichiers explicites (P1_, P2_...)

✓ Plus de flexibilite

📋 Bordereau recapitulatif

Ajoutez includeBordereau=true pour recevoir automatiquement un bordereau PDF avec la liste de toutes vos pieces.

• Le bordereau est toujours retourne en fichier separe

• Contient : numero, nom et nombre de pages de chaque piece

• Coute 1 credit supplementaire

Exemple : PDFs separes avec bordereau

curl -X POST https://hellostamppdf.com/api/v1/stamp \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "files=@contrat.pdf" \
  -F "files=@annexe.pdf" \
  -F "files=@conditions.pdf" \
  -F 'config={"shape":"ROUND","position":"TOP_RIGHT","topText":"PIECE N°","bottomText":"Cabinet Martin","fontSize":12,"color":"#dc2626","startNumber":1,"width":100,"height":100,"marginX":20,"marginY":20,"borderWidth":2,"borderColor":"#dc2626","stampEffect":true}' \
  -F "outputType=SEPARATE" \
  -F "includeBordereau=true" \
  -F "caseTitle=Affaire Martin c/ Dupont - TGI Paris"

Reponse avec SEPARATE + bordereau

{
  "success": true,
  "jobId": "clxxx...",
  "totalPages": 20,
  "creditsUsed": 21,  // 20 pages + 1 bordereau
  "creditsRemaining": 79,
  "processingTime": 2456,
  "files": [
    {
      "name": "P1_contrat.pdf",
      "data": "base64_encoded_pdf..."
    },
    {
      "name": "P2_annexe.pdf",
      "data": "base64_encoded_pdf..."
    },
    {
      "name": "P3_conditions.pdf",
      "data": "base64_encoded_pdf..."
    },
    {
      "name": "bordereau.pdf",
      "data": "base64_encoded_pdf..."
    }
  ]
}

Exemple : PDF fusionne avec bordereau

curl -X POST https://hellostamppdf.com/api/v1/stamp \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "files=@contrat.pdf" \
  -F "files=@annexe.pdf" \
  -F "files=@conditions.pdf" \
  -F 'config={"shape":"RECTANGLE","position":"TOP_RIGHT","topText":"PIECE N°","fontSize":12,"color":"#000000","startNumber":1,"width":120,"height":60,"marginX":20,"marginY":20,"borderWidth":2,"borderColor":"#000000","stampEffect":false}' \
  -F "outputType=MERGED" \
  -F "includeBordereau=true" \
  -F "caseTitle=Affaire Martin c/ Dupont"

Reponse avec MERGED + bordereau

{
  "success": true,
  "jobId": "clxxx...",
  "totalPages": 20,
  "creditsUsed": 21,  // 20 pages + 1 bordereau
  "creditsRemaining": 79,
  "processingTime": 2123,
  "files": [
    {
      "name": "stamped_merged.pdf",      // Toutes les pieces fusionnees
      "data": "base64_encoded_pdf..."
    },
    {
      "name": "bordereau.pdf",           // Bordereau separe
      "data": "base64_encoded_pdf..."
    }
  ]
}

POST /api/v1/bordereau - Generer uniquement le bordereau

Genere un bordereau PDF sans tamponner de fichiers (utile pour les workflows separes)

💡 Cas d'usage

Cette API est conçue pour les applications qui tamponnent les PDFs en local et ont besoin uniquement de generer le bordereau recapitulatif. Ideal pour contourner les limites de taille de payload.

Parametres de la requete (application/json)

pieces (requis)

Tableau des pieces a inclure dans le bordereau

[
  {
    "number": 1,        // Numero de la piece
    "name": "Contrat",  // Nom de la piece
    "pageCount": 5      // Nombre de pages
  },
  {
    "number": 2,
    "name": "Annexe A",
    "pageCount": 3
  }
]

caseTitle (optionnel)

Titre du dossier affiche dans le bordereau

Exemple de requete

curl -X POST https://hellostamppdf.com/api/v1/bordereau \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pieces": [
      { "number": 1, "name": "Contrat de vente", "pageCount": 5 },
      { "number": 2, "name": "Annexe financiere", "pageCount": 3 },
      { "number": 3, "name": "Conditions generales", "pageCount": 12 }
    ],
    "caseTitle": "Affaire Martin c/ Dupont - TGI Paris"
  }'

Reponse (200 OK)

{
  "success": true,
  "creditsUsed": 1,
  "creditsRemaining": 99,
  "processingTime": 234,
  "file": {
    "name": "bordereau.pdf",
    "data": "base64_encoded_pdf..."
  }
}

⚠️ Important

• Cette API ne tamponne aucun fichier, elle genere uniquement le bordereau
• Coute 1 credit (pour le bordereau)
• Aucun fichier PDF n'est envoye dans la requete, seulement les metadonnees
• Le bordereau est retourne au format PDF encode en base64

Codes d'erreur HTTP

400Requete invalide (parametres manquants ou incorrects)

401Non authentifie (cle API manquante ou invalide)

402Credits insuffisants

413Fichier trop volumineux (max 50MB par fichier)

500Erreur serveur interne

Limites et quotas

Taille des fichiers

• Maximum 50MB par fichier PDF
• Maximum 20 fichiers par requete

Rate limiting

• 60 requetes par minute
• 1000 requetes par jour

Pret a commencer ?

Creez un compte gratuitement et recevez 10 credits pour tester l'API

Creer un compte gratuit Nous contacter