Guides

Expédiez rapidement votre premier flux de signature électronique avec Firma : un guide de démarrage pour les développeurs

Écrit par

Contenu

Vous êtes développeur et vous possédez déjà votre compte Firma ? Parfait. Ce guide vous accompagne de l'« obtention de la clé API » à un flux de signature intégré et opérationnel. Nous irons à l'essentiel, nous nous concentrerons sur les décisions et nous vous renverrons directement aux extraits de code prêts à l'emploi de la documentation.

Vous cherchez le guide non technique ? Cliquez ici.

Ce que vous allez faire

  1. Modéliser l'isolation des clients grâce aux espaces de travail (Workspaces)

  2. Créer un modèle réutilisable

  3. Envoyer une demande de signature

  4. Intégrer l'expérience de signature ou rediriger l'utilisateur

  5. Tout suivre grâce aux Webhooks

La tarification est simple. C'est €0,049 par enveloppe, avec des tests sur de vrais documents gratuits afin que vous puissiez créer et tester de bout en bout.

Prérequis

Clé API de l'entreprise ou de l'espace de travail depuis votre tableau de bord

  • Un PDF que vous pouvez transformer en modèle

  • Un serveur pour exécuter le code de génération des JWT et recevoir les webhooks

Besoin d'un rappel sur le flux global ? Consultez le guide d'installation complet.

1) Créer un espace de travail pour chaque client

Les espaces de travail offrent à chaque client un espace privé et cloisonné avec des modèles, des documents et une utilisation isolés. C'est le moyen le plus propre de concevoir une séparation multi-tenant de type SaaS sans fuite de données entre les clients.

Créer un espace de travail
https://docs.firma.dev/api-reference/v01.00.01/workspaces/create-a-new-workspace
Créer un espace de travail
https://docs.firma.dev/api-reference/v01.00.01/workspaces/create-a-new-workspace
Créer un espace de travail
https://docs.firma.dev/api-reference/v01.00.01/workspaces/create-a-new-workspace

Pratique : les paramètres de l'espace de travail, tels que le modèle d'e-mail et le fuseau horaire, sont propres à chaque espace de travail.

Guide des paramètres de l'espace de travail
https://docs.firma.dev/guides/workspace-settings
Guide des paramètres de l'espace de travail
https://docs.firma.dev/guides/workspace-settings
Guide des paramètres de l'espace de travail
https://docs.firma.dev/guides/workspace-settings

2) Créer un modèle réutilisable

Les modèles contiennent le PDF ainsi que les rôles et les champs, ce qui vous permet d'envoyer le même document plusieurs fois à des destinataires différents.

Créer un modèle (API)
https://docs.firma.dev/api-reference/v01.00.01/templates/create-template
Créer un modèle (API)
https://docs.firma.dev/api-reference/v01.00.01/templates/create-template
Créer un modèle (API)
https://docs.firma.dev/api-reference/v01.00.01/templates/create-template

Option A : Permettre aux utilisateurs de concevoir des modèles dans votre application

Intégrez l'éditeur de modèles à l'aide d'un jeton JWT à durée de vie courte.

Éditeur de modèles intégrable (guide)
https://docs.firma.dev/guides/embeddable-template-editor
Éditeur de modèles intégrable (guide)
https://docs.firma.dev/guides/embeddable-template-editor
Éditeur de modèles intégrable (guide)
https://docs.firma.dev/guides/embeddable-template-editor

Générez le jeton côté serveur.

Générer un jeton JWT pour l'intégration de modèles
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-embedding-templates
Générer un jeton JWT pour l'intégration de modèles
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-embedding-templates
Générer un jeton JWT pour l'intégration de modèles
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-embedding-templates

3) Créer la demande de signature

Transformez votre modèle en transaction active. Vous pouvez également la créer à partir d'un simple fichier PDF si vous préférez. La référence couvre les destinataires, les champs, les rappels et les règles de validation.

Créer une demande de signature
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/create-signing-request
Créer une demande de signature
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/create-signing-request
Créer une demande de signature
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/create-signing-request

Optionnel : laisser les utilisateurs professionnels remplir les détails et l'envoyer depuis votre interface

Intégrez l'éditeur de demandes de signature avec un jeton JWT de 7 jours.

Éditeur de demandes de signature intégrable (guide)
https://docs.firma.dev/guides/embeddable-signing-request-editor
Éditeur de demandes de signature intégrable (guide)
https://docs.firma.dev/guides/embeddable-signing-request-editor
Éditeur de demandes de signature intégrable (guide)
https://docs.firma.dev/guides/embeddable-signing-request-editor

Générez le jeton JWT côté serveur.

Générer un jeton JWT pour l'éditeur de demandes de signature
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-signing-request
Générer un jeton JWT pour l'éditeur de demandes de signature
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-signing-request
Générer un jeton JWT pour l'éditeur de demandes de signature
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-signing-request

4) Envoyer la demande de signature

Lorsque vous êtes prêt, déclenchez l'envoi.

Envoyer la demande de signature
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/send-signing-request
Envoyer la demande de signature
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/send-signing-request
Envoyer la demande de signature
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/send-signing-request

5) Proposer la signature au sein de votre produit ou via une redirection

Signature intégrée

Chaque destinataire signe sur une URL unique qui suit ce modèle :

https://app.firma.dev/signing/{signing_request_user_id}.

Signature intégrable (modèle d'iframe et conseils)
https://docs.firma.dev/guides/embeddable-signing
Signature intégrable (modèle d'iframe et conseils)
https://docs.firma.dev/guides/embeddable-signing
Signature intégrable (modèle d'iframe et conseils)
https://docs.firma.dev/guides/embeddable-signing

Vous récupérerez l'identifiant signing_request_user_id à l'aide de l'API.

Obtenir les utilisateurs de la demande de signature
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/get-signing-request-users
Obtenir les utilisateurs de la demande de signature
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/get-signing-request-users
Obtenir les utilisateurs de la demande de signature
https://docs.firma.dev/api-reference/v01.00.01/signing-requests/get-signing-request-users

Redirection pour signature

Alternativement, vous pouvez rediriger les destinataires vers l'interface de signature hébergée. Consultez le guide ci-dessus pour plus de détails.

6) Tout suivre avec les webhooks

Écoutez les événements tels que créé, envoyé, consulté, signé et terminé pour mettre à jour votre système en temps réel. Le guide comprend la vérification HMAC, la rotation, les tentatives et une liste de contrôle pour la production.

Guide des Webhooks
https://docs.firma.dev/guides/webhooks
Guide des Webhooks
https://docs.firma.dev/guides/webhooks
Guide des Webhooks
https://docs.firma.dev/guides/webhooks
Créer un webhook (API)
https://docs.firma.dev/api-reference/v01.00.01/webhooks/create-webhook
Créer un webhook (API)
https://docs.firma.dev/api-reference/v01.00.01/webhooks/create-webhook
Créer un webhook (API)
https://docs.firma.dev/api-reference/v01.00.01/webhooks/create-webhook

Notes rapides sur l'architecture

  • JWT. Générez-les côté serveur. Les jetons de l'éditeur de modèles ont une durée de vie courte ; les jetons de l'éditeur de demandes de signature expirent après 7 jours.

  • Espaces de travail pour le SaaS. Maintenez vos clients totalement cloisonnés. Vos opérateurs travaillent toujours à partir d'une seule API.

  • Tarifs et déploiement. Commencez avec les enveloppes gratuites incluses, puis passez en production. Pas de minimum requis. €0,049 par enveloppe.

Et après ?

  1. Connectez votre premier espace de travail

  2. Ajoutez un modèle

  3. Envoyez votre première demande

  4. Choisissez entre l'intégration ou la redirection

  5. Configurez les webhooks

👉 Obtenir la clé API - aucune carte de crédit requise.

  1. Titre

Image de fond

Prêt à ajouter des signatures électroniques à votre application ?

Commencez gratuitement. Aucune carte de crédit requise. Payez seulement 0,049 € par enveloppe lorsque vous serez prêt à lancer votre activité.

Image de fond

Prêt à ajouter des signatures électroniques à votre application ?

Commencez gratuitement. Aucune carte de crédit requise. Payez seulement 0,049 € par enveloppe lorsque vous serez prêt à lancer votre activité.

Image de fond

Prêt à ajouter des signatures électroniques à votre application ?

Commencez gratuitement. Aucune carte de crédit requise. Payez seulement 0,049 € par enveloppe lorsque vous serez prêt à lancer votre activité.