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

Si vous intégriez des 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 seul 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 pour la signature électronique

@firma-dev/sdk est le client TypeScript officiel et entièrement typé pour l'API de Firma.dev. Chaque point de terminaison est exposé sous forme de méthode typée, regroupée par ressource, ce qui vous permet de bénéficier de l'autocomplétion de l'éditeur et de la sécurité au moment de la compilation plutôt que de tuyauterie HTTP brute. Le client couvre l'ensemble des 66 points de terminaison : modèles, demandes de signature, webhooks, espaces de travail, champs personnalisés, domaines de messagerie, modèles d'e-mail, conditions du signataire, gestion des JWT et paramètres.

Il s'exécute côté serveur sur Node 18 ou version ultérieure, utilise le fetch intégré, est livré sans 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 direct. Lorsqu'un point de terminaison change, les types changent avec lui, de sorte qu'un champ incorrect génère 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, ni de relire la référence à chaque fois que vous touchez à un point de terminaison. Les agences qui automatisent les flux de signature des clients bénéficient du même avantage : configurez l'intégration une seule fois avec des méthodes typées et laissez le compilateur détecter les écarts.

Un coup d'œil rapide à @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);

L'attente d'une méthode renvoie directement le corps de la réponse analysée. 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 ayant échoué lèvent une erreur typée FirmaError qui contient le code d'état et le corps de l'erreur analysé, afin que la gestion des erreurs reste 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.

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

Commencer avec le SDK Firma.dev

Installez le SDK, insérez votre clé d'API et envoyez votre première requête. Firma.dev est payé à l'utilisation à 0,049 € par enveloppe (environ 5 ¢ USD), sans contrat ni minimum mensuel.

Commencez à utiliser Firma.dev gratuitement, sans carte de crédit requise.