Aller au contenu principal

Télécharger un fichier en tant que modèle

Ce guide vous guide à travers le processus complet de création d’un modèle et de téléchargement d’un fichier PDF, image ou Word à utiliser comme modèle de document dans Legalesign.

astuce

Besoin d’un retour en temps réel sur le traitement du téléchargement ? Consultez Suivre la progression du téléchargement avec les abonnements.

Ce que vous apprendrez​

À la fin de ce guide, vous saurez comment :

  1. Créer un nouveau modèle dans votre groupe Legalesign
  2. Obtenir l’ID du modèle et l’URL de téléchargement depuis la réponse de la mutation
  3. Télécharger votre fichier source vers le modèle
  4. Vérifier que le téléchargement a réussi

Prérequis​

Avant de commencer, assurez-vous d’avoir :

  • Un compte Legalesign avec accès à l’API
  • Vos identifiants d’authentification (voir notre guide d’authentification)
  • Un fichier PDF, image ou Word prêt à être téléchargé (taille maximale 50 Mo)
  • Votre ID de groupe (l’espace de travail où vous souhaitez créer le modèle)

Le processus complet​

Étape 1 : Créer un modèle​

Tout d’abord, créez un modèle vide dans Legalesign. Cela retourne à la fois l’ID du modèle et une URL de téléchargement pré-signée pour le téléchargement du PDF. Pour cela, vous devez exécuter une mutation GraphQL, si vous ne l’avez jamais fait, voir l’Introduction à GraphQL.

Qu’est-ce qu’un modèle ?​

Un modèle est une structure de document réutilisable dans Legalesign. Une fois que vous avez téléchargé un PDF vers un modèle, vous pouvez :

  • Ajouter des champs de signature et des champs de formulaire
  • L’envoyer à plusieurs destinataires
  • Le réutiliser pour différents signataires

Mutation GraphQL​

mutation CreateTemplate($input: templateCreateInput!) {
  createTemplate(input: $input) {
    id
    uploadUrl
  }
}

Variables d’entrée​

{
  "input": {
    "groupId": "grpYourGroupAPIId",
    "title": "Employment Contract Template"
  }
}

Explication des paramètres​

  • groupId : l’ID base 64 de votre groupe/espace de travail (vous pouvez le récupérer depuis l’URL dans la Console https://console.legalesign.com/)
  • title : un nom descriptif pour votre modèle (vous pouvez le modifier plus tard)

Étape 2 : Extraire l’ID du modèle et l’URL de téléchargement​

La mutation renvoie un objet templateCreateOutput. Enregistrez le champ id et la chaîne uploadUrl.

Exemple de réponse :

{
  "data": {
    "createTemplate": {
      "id": "dHBsYjQ5YTg5NWQtYWRhMy0xMWYwLWIxZGMtMDY5NzZlZmU0MzIx",
      "uploadUrl": "https://s3.amazonaws.com/bucket/path?signature=..."
    }
  }
}
astuce

L’ID du modèle est une chaîne codée en Base64. Enregistrez les deux valeurs de la réponse. L’uploadUrl est de courte durée et doit être utilisée rapidement.

Étape 3 : Téléchargez votre PDF​

Utilisez l’uploadUrl retournée pour télécharger votre fichier PDF directement sur S3. Cela variera selon votre environnement de développement. Dans notre exemple en JavaScript, nous avons utilisé fetch, mais vous pouvez utiliser d’autres bibliothèques, y compris aws-amplify.

Exemples complets fonctionnels​

import fs from 'fs';

const AUTH_TOKEN = '<token-from-authentication-guide>';

const uploadPdfTemplate = async (groupId, title, pdfFilePath) => {
  const graphqlEndpoint = 'https://graphql.uk.legalesign.com/graphql';
  
  // Step 1: Create the template
  console.log('Creating template...');
  const createResponse = await fetch(graphqlEndpoint, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${AUTH_TOKEN}`
    },
    body: JSON.stringify({
      query: `
        mutation CreateTemplate($input: templateCreateInput!) {
          createTemplate(input: $input) {
            id
            uploadUrl
          }
        }
      `,
      variables: {
        input: {
          groupId: groupId,
          title: title
        }
      }
    })
  });
  
  const createResult = await createResponse.json();
  const templateId = createResult.data.createTemplate.id;
  const uploadUrl = createResult.data.createTemplate.uploadUrl;
  console.log('Template created with ID:', templateId);
  
  // Step 2: Upload the PDF
  console.log('Uploading PDF...');
  const fileData = fs.readFileSync(pdfFilePath);
  
  const uploadResponse = await fetch(uploadUrl, {
    method: 'PUT',
    body: fileData,
    headers: {
      'Content-Type': 'application/pdf'
    }
  });
  
  if (!uploadResponse.ok) {
    throw new Error(`Upload failed: ${uploadResponse.statusText}`);
  }
  
  console.log('PDF uploaded successfully!');
  
  return {
    success: true,
    templateId: templateId,
    title: title
  };
};

// Usage example
uploadPdfTemplate(
  'grpYourGroupId',
  'Employment Contract',
  './contract.pdf'
).then(result => {
  console.log('Complete!', result);
}).catch(error => {
  console.error('Error:', error);
});

Aucune dépendance supplémentaire requise — Node.js 18+ intègre fetch nativement.

Que se passe-t-il après le téléchargement ?​

Une fois votre PDF téléchargé, Legalesign effectue automatiquement :

  1. Analyse anti-virus - S’assure que le fichier est sûr
  2. Validation ou conversion du fichier - Vérifie que les PDF sont valides, ou convertit les fichiers pris en charge comme les documents Word et images en PDF
  3. Extraction des informations de pages - Obtient le nombre de pages et leurs dimensions
  4. Traitement du fichier - L’optimise pour la visualisation et la signature
  5. Stockage sécurisé - Le déplace vers un stockage permanent

Ce processus prend généralement quelques secondes. Une fois terminé, votre modèle est prêt à être utilisé !

Ajouter des signatures et des champs​

Si vous souhaitez automatiser les participants et le placement des champs, vous pouvez préparer le fichier source avant le téléchargement de plusieurs façons :

  • Tags texte - Ajoutez des tags texte Legalesign dans le document source afin que les participants, champs de signature et champs de formulaire puissent être créés automatiquement lors du traitement. Voir l’explication de l’API REST dans le tutoriel de démarrage rapide et la référence de l’endpoint Convert text tags.
  • Champs PDF intégrés - Si votre PDF contient déjà des champs de formulaire intégrés, Legalesign peut les utiliser dans le cadre du workflow de téléchargement et de préparation du modèle.

Étapes suivantes​

Maintenant que vous avez un modèle avec un PDF, vous pouvez :

  1. Ajouter des champs de signature - Utilisez la mutation createTemplateElement pour ajouter des champs
  2. Créer des rôles - Définissez qui signera le document
  3. Envoyer pour signature - Utilisez la mutation send pour envoyer aux destinataires

Problèmes courants et solutions​

Erreur « Pas d’autorisation »​

Vérifiez que votre ID de groupe est correct et que vous êtes authentifié avec le bon compte.

Erreur « Fichier trop volumineux »​

Compressez votre PDF — la taille maximale est de 50 Mo.

URL de téléchargement expirée​

Utilisez rapidement l’uploadUrl retournée par createTemplate. Si elle expire avant que vous ne téléchargiez, demandez une nouvelle URL avec la requête upload en utilisant l’ID de modèle enregistré.

Erreur « PDF invalide »​

Ouvrez le PDF dans un lecteur PDF pour vérifier qu’il est valide, puis ré-exportez ou enregistrez-le à nouveau.

Suivre la progression du téléchargement​

Pour obtenir un retour en temps réel sur le traitement du téléchargement (analyse, validation, finalisation), utilisez les abonnements. Voir Suivre la progression du téléchargement avec les abonnements.

Export This Article

Save a copy of this page as PDF or plain text.