Actualizaciones de producto

El SDK de firma electrónica de Firma.dev para TypeScript ya está aquí: tipado, sin dependencias y con cobertura para todos los endpoints

Escrito por

Si has estado integrando firmas electrónicas es tu producto mediante llamadas a fetch escritas a mano, ese trabajo ahora es opcional. El SDK oficial de TypeScript para Firma.dev ya está disponible es npm. Un cliente tipado, los 66 endpoints de la API de partners, sin dependencias de tiempo de ejecución. Instálalo y empieza a firmar.

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

Qué incluye el SDK de TypeScript para firma electrónica

@firma-dev/sdk es el cliente oficial y completamente tipado de TypeScript para la API de Firma.dev. Cada endpoint se expone como un método tipado, agrupado por recurso, para que disfrutes de autocompletado es el editor y seguridad es tiempo de compilación es lugar de tener que lidiar con la fontanería HTTP en bruto. El cliente cubre los 66 endpoints: plantillas, solicitudes de firma, webhooks, espacios de trabajo, campos personalizados, dominios de correo electrónico, plantillas de correo electrónico, términos del firmante, gestión de JWT y ajustes.

Se ejecuta es el lado del servidor es Node 18 o superior, utiliza el fetch nativo, no tiene dependencias de tiempo de ejecución y cuenta con licencia MIT. La versión actual es la 0.2.0.

Por qué es importante un cliente de API tipado para firmas electrónicas

El SDK se genera directamente a partir de la misma especificación OpenAPI que alimenta la referencia de la API. Esto significa que las estructuras de solicitud y respuesta siempre coinciden con la API es producción. Cuando un endpoint cambia, los tipos cambian con él, por lo que un campo no coincidente se convierte es un error de compilación es tu editor es lugar de un 400 que tengas que depurar es producción.

Para un equipo de SaaS que integra la firma es su propio producto, esto elimina toda una categoría de código de unión. Olvídate de mantener una capa HTTP a medida, de adivinar la forma de los payloads o de volver a leer la referencia cada vez que tocas un endpoint. Las agencias que automatizan flujos de trabajo de firma para clientes obtienen la misma ventaja: crea la integración una vez con métodos tipados y deja que el compilador detecte cualquier desfase.

Un vistazo rápido a @firma-dev/sdk

Autentícate con una sola clave de API. El cliente la envía es cada solicitud y procesa las respuestas por ti.

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);

Esperar un método devuelve directamente el cuerpo de la respuesta procesado. Cuando necesites el código de estado HTTP o los encabezados, llama a .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"));

Las solicitudes fallidas lanzan un FirmaError tipado que incluye el código de estado y el cuerpo del error procesado, manteniendo el control de errores legible:

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;
  }
}

Guarda tu clave de API es una variable de entorno o es un gestor de secretos, nunca es código del lado del cliente. El SDK está diseñado para usarse es el servidor.

Lee la guía completa. La instalación, autenticación, guía de inicio rápido, operaciones comunes, gestión de errores y paginación se detallan es la documentación: docs.firma.dev/guides/typescript-sdk. Cada endpoint de la referencia de la API ahora incluye un ejemplo de @firma-dev/sdk listo para copiar y pegar, de modo que puedas obtener una llamada funcional para tus parámetros exactos. Consulta la entrada del registro de cambios v1.28.0 para ver el resumen completo de la v01.28.00.

Empieza a usar el SDK de Firma.dev

Instala el SDK, añade tu clave de API y envía tu primera solicitud. Firma.dev es de pago por uso a 0,049 € por sobre (aproximadamente 5 centavos de USD), sin contratos ni consumos mínimos mensuales.

Empieza a usar Firma.dev de forma gratuita, sin necesidad de tarjeta de crédito.

  1. Encabezado

Artículos relacionados

Nuestra plataforma está diseñada para capacitar a las empresas de todos los tamaños para trabajar de manera más inteligente y alcanzar sus objetivos con confianza.

Imagen de fondo

¿Listo para añadir firmas electrónicas a tu aplicación?

Comienza gratis. No se requiere tarjeta de crédito. Paga solo 0,049 € por sobre cuando estés listo para empezar.

Imagen de fondo

¿Listo para añadir firmas electrónicas a tu aplicación?

Comienza gratis. No se requiere tarjeta de crédito. Paga solo 0,049 € por sobre cuando estés listo para empezar.

Imagen de fondo

¿Listo para añadir firmas electrónicas a tu aplicación?

Comienza gratis. No se requiere tarjeta de crédito. Paga solo 0,049 € por sobre cuando estés listo para empezar.