SDKs

Instala o descarga el SDK de tu lenguaje, como firmame.ts para TypeScript. Se encargan de firmar cada petición por ti.

Los SDKs construyen el HMAC de cada petición y te dejan trabajar con objetos en vez de con cadenas firmadas.

LenguajeCómo se obtiene
Nodefirmamex.js
TypeScriptfirmame.ts — npm install firmame.ts
PHPfirmamex.php
Pythonfirmamex.py
.NETSignmageSDKCore.dll
Java 8firmamex-services.zip

firmame.ts requiere Node 20 o superior.

Inicializar

Todos reciben lo mismo: tu Web ID y tu API key. Cárgalos desde variables de ambiente, no escritos en el código.

const FirmamexServices = require('./firmamex');

const services = FirmamexServices(
  process.env.FIRMAME_WEB_ID,
  process.env.FIRMAME_API_KEY,
);

A partir de ahí, cada endpoint de la referencia tiene su método. Por ejemplo, crear un documento:

const response = await services.request({
  url_doc: { url: 'https://ejemplo.com/contrato.pdf', name: 'contrato.pdf' },
  stickers: [
    {
      authority: 'EMAIL_LINK',
      data: '[email protected]',
      page: 0,
      rect: { lx: 330, ly: 300, tx: 530, ty: 400 },
    },
  ],
});

Si tu lenguaje no está en la lista

La API es HTTP con JSON, así que se puede usar desde cualquier parte. Lo único que hay que implementar es el encabezado de autenticación, Credenciales y firma lo explica con un ejemplo completo.

En esta página