Guides

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

Écrit par

Boîte à outils ouverte remplie de clés colorées, de tournevis, d'un marteau et de pinces, avec des écrous et des boulons éparpillés autour.

Vous êtes développeur et possédez déjà votre compte firma ? Parfait. Ce guide vous accompagne depuis la « clé API en main » jusqu'à un flux de signature intégré et opérationnel. Nous irons droit au but, en nous concentrant sur les décisions clés et en vous renvoyant directement aux extraits de code fonctionnels de la documentation.

Vous cherchez le guide non technique ? Cliquez ici.

Ce que vous allez faire

  1. Modéliser l'isolation des clients avec les 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 configurer une redirection

  5. Tout suivre grâce aux webhooks

La tarification est simple. C'est €0.049 par enveloppe, avec la possibilité de tester avec de vrais documents, gratuitement, afin de pouvoir développer et tester de bout en bout.

Prérequis

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

  • Un PDF que vous pouvez convertir en modèle

  • Un environnement pour exécuter du code serveur pour la génération de JWT et les webhooks

Besoin d'un rappel sur le flux global ? Consultez le Guide de configuration 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 la façon la plus propre de mettre en place une séparation multi-locataire de type SaaS sans fuite de données entre 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

Bon à savoir : les paramètres de l'espace de travail, comme le texte des e-mails et le fuseau horaire, sont définis par 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 : Laisser les utilisateurs concevoir des modèles dans votre application

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

É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 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 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 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 le créer à partir d'un PDF brut si vous préférez. La documentation de 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

Facultatif : laisser les utilisateurs métier renseigner les détails et envoyer depuis votre interface

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

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

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

Générer un JWT pour l'éditeur de demande de signature
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-signing-request
Générer un JWT pour l'éditeur de demande de signature
https://docs.firma.dev/api-reference/v01.00.01/jwt-management/generate-jwt-token-for-signing-request
Générer un JWT pour l'éditeur de demande 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 par redirection

Signature intégrée

Chaque destinataire signe via une URL unique selon 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 depuis 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

Signature par redirection

Vous pouvez également rediriger les destinataires vers l'interface de signature hébergée. Consultez le même guide ci-dessus pour plus de détails.

6) Tout suivre avec les webhooks

Écoutez des événements tels que created, sent, viewed, signed et completed pour mettre à jour votre système en temps réel. Le guide couvre la vérification HMAC, la rotation, les nouvelles 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 pour l'éditeur de modèles sont à courte durée de vie ; ceux de l'éditeur de demande de signature expirent après 7 jours.

  • Espaces de travail pour le SaaS. Maintenez un cloisonnement total entre les clients. Vos opérateurs continuent d'opérer depuis une seule API.

  • Tarification et déploiement. Commencez avec les enveloppes gratuites incluses, puis passez en production. Aucun minimum requis. €0.049 par enveloppe.

Et ensuite ?

  1. Connectez votre premier espace de travail

  2. Ajoutez un modèle

  3. Envoyez votre première demande

  4. Choisissez l'intégration ou la redirection

  5. Configurez les webhooks

👉 Obtenir la clé API - sans 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é.