Mises à jour de produit

Le SDK de signature électronique TypeScript de Firma.dev est là : typé, sans dépendances, couvrant tous les points de terminaison

Écrit par

Si vous intégriez jusqu'ici les signatures électroniques dans votre produit à l'aide d'appels fetch écrits à la main, ce travail est désormais facultatif. Le SDK TypeScript officiel de Firma.dev est disponible sur npm. Un client typé, l'ensemble des 66 points de terminaison de l'API partenaire, aucune dépendance d'exécution. Installez-le et commencez à signer.

npm install @firma-dev/sdk
npm install @firma-dev/sdk
npm install @firma-dev/sdk

Ce que contient le SDK TypeScript de signature électronique

@firma-dev/sdk est le client TypeScript officiel et entièrement typé pour l'API Firma.dev. Chaque point de terminaison est exposé sous forme de méthode typée, regroupée par ressource, vous offrant ainsi l'autocomplétion dans l'éditeur et la sécurité à la compilation au lieu d'une plomberie HTTP brute. Le client couvre les 66 points de terminaison : modèles, demandes de signature, webhooks, espaces de travail, champs personnalisés, domaines de messagerie, modèles d'e-mails, conditions du signataire, gestion JWT et paramètres.

Il s'exécute côté serveur sur Node 18 ou version ultérieure, utilise le fetch natif, ne comporte aucune dépendance d'exécution et est sous licence MIT. La version actuelle est la 0.2.0.

Pourquoi un client d'API de signature électronique typé est important

Le SDK est généré directement à partir de la même spécification OpenAPI qui alimente la référence de l'API. Cela signifie que les structures de requête et de réponse correspondent toujours à l'API en production. Lorsqu'un point de terminaison change, les types changent avec lui, de sorte qu'un champ incompatible devient une erreur de compilation dans votre éditeur plutôt qu'une erreur 400 à déboguer en production.

Pour une équipe SaaS intégrant la signature dans son propre produit, cela élimine toute une catégorie de code d'intégration. Plus besoin de maintenir une couche HTTP sur mesure, de deviner la structure des charges utiles ou de relire la documentation de référence à chaque modification d'un point de terminaison. Les agences automatisant les flux de signature client bénéficient du même avantage : développez l'intégration une fois avec des méthodes typées et laissez le compilateur détecter les dérives.

Un aperçu rapide de @firma-dev/sdk

Authentifiez-vous avec une seule clé d'API. Le client l'envoie à chaque requête et analyse les réponses pour vous.

import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: process.env.FIRMA_API_KEY });

const templates = await firma.templates.listTemplates();
console.log(templates);
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: process.env.FIRMA_API_KEY });

const templates = await firma.templates.listTemplates();
console.log(templates);
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: process.env.FIRMA_API_KEY });

const templates = await firma.templates.listTemplates();
console.log(templates);

Attendre une méthode retourne directement le corps analysé de la réponse. Lorsque vous avez besoin du statut HTTP ou des en-têtes, appelez .withRawResponse() :

const { data, rawResponse } = await firma.templates
  .listTemplates()
  .withRawResponse();

console.log(rawResponse.status);
console.log(rawResponse.headers.get("x-request-id"));
const { data, rawResponse } = await firma.templates
  .listTemplates()
  .withRawResponse();

console.log(rawResponse.status);
console.log(rawResponse.headers.get("x-request-id"));
const { data, rawResponse } = await firma.templates
  .listTemplates()
  .withRawResponse();

console.log(rawResponse.status);
console.log(rawResponse.headers.get("x-request-id"));

Les requêtes échouées lèvent une erreur typée FirmaError qui contient le code de statut et le corps de l'erreur analysé, rendant ainsi la gestion des erreurs lisible :

import { FirmaClient, FirmaError } from "@firma-dev/sdk";

try {
  await firma.templates.getTemplate({ id: "does-not-exist" });
} catch (err) {
  if (err instanceof FirmaError) {
    console.error(err.statusCode); // e.g. 404
    console.error(err.body);       // parsed error payload
  } else {
    throw err;
  }
}
import { FirmaClient, FirmaError } from "@firma-dev/sdk";

try {
  await firma.templates.getTemplate({ id: "does-not-exist" });
} catch (err) {
  if (err instanceof FirmaError) {
    console.error(err.statusCode); // e.g. 404
    console.error(err.body);       // parsed error payload
  } else {
    throw err;
  }
}
import { FirmaClient, FirmaError } from "@firma-dev/sdk";

try {
  await firma.templates.getTemplate({ id: "does-not-exist" });
} catch (err) {
  if (err instanceof FirmaError) {
    console.error(err.statusCode); // e.g. 404
    console.error(err.body);       // parsed error payload
  } else {
    throw err;
  }
}

Conservez votre clé d'API dans une variable d'environnement ou un gestionnaire de secrets, jamais dans le code côté client. Le SDK est conçu pour une utilisation côté serveur.

Consultez le guide complet. L'installation, l'authentification, le démarrage rapide, les opérations courantes, la gestion des erreurs et la pagination sont tous détaillés dans la documentation : docs.firma.dev/guides/typescript-sdk. Chaque point de terminaison dans la référence de l'API inclut désormais un exemple @firma-dev/sdk à copier-coller, vous permettant ainsi d'obtenir un appel fonctionnel avec vos paramètres exacts. Consultez l'entrée du journal des modifications v1.28.0 pour un récapitulatif complet de la v01.28.00.

Commencez avec le SDK Firma.dev

Installez le SDK, intégrez votre clé d'API et envoyez votre première requête. Firma.dev fonctionne selon une tarification à l'usage à 0,049 € par enveloppe (environ 5 ¢ USD), sans contrat ni minimum mensuel.

Commencez gratuitement avec Firma.dev, aucune carte bancaire requise.

  1. Titre

Articles connexes

Notre plateforme est conçue pour permettre aux entreprises de toutes tailles de travailler plus intelligemment et d'atteindre leurs objectifs avec confiance.

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é.