Crear un documento

El endpoint principal. Sube un PDF, coloca los recuadros de firma sobre él y devuelve la URL donde se puede firmar.

El documento puede venir de una URL, de Base64 o de una plantilla ya registrada — elige uno. Cada entrada de stickers es un firmante en un lugar; dale email y configura un flujo si quieres que Firmame mande las invitaciones, si no, reparte tú document_url.

Autenticación

signmage

Authorization<token>

Cada petición lleva Authorization: signmage {webId}:{firma}, donde firma es el Base64 de HMAC-SHA256(apiKey, cadenaFirmada).

Qué va dentro de cadenaFirmada depende de la petición:

Petición	`cadenaFirmada`
`GET`	La URI completa incluyendo el query string, exactamente como se envía
`POST` con JSON	El cuerpo JSON, re-serializado compacto (sin espacios ni salto de línea final)
`POST` multipart	El SHA-256 en Base64 del archivo, que además se manda en el header `Content-SHA256`

Dos detalles que conviene resolverlos desde el principio:

En GET, la URI se firma tal como se envía, así que el orden y el encoding de los parámetros importan.
En POST, la comparación se hace contra tu JSON re-serializado en forma compacta. Manda JSON compacto y canónico para que las firmas coincidan.

Una firma que no coincide devuelve 401 con el cuerpo vacío. Como la misma respuesta cubre un web ID desconocido, una llave inactiva y una firma que no coincide, revisa las tres cosas al diagnosticar.

En: header

Cuerpo de la petición

application/json

Definiciones de TypeScript

Usa el tipo request body en TypeScript.

url_doc?

Una URL desde la que Firmame descarga el PDF.

b64_doc?

El PDF en línea, codificado en Base64.

template?

Una plantilla dada de alta antes con POST /developers/template/save.

stickers?array<>

Los recuadros de firma. Omítelo para guardar el documento sin firmantes.

workflow?

Quién firma, en qué orden, y cómo los persigue Firmame.

Adjúntalo a POST /developers/json para dejar el flujo armado al crear el documento, o mándalo a POST /api/{firmamexId}/workflow para agregarlo o cambiarlo después.

Todas las propiedades aceptan snake_case y camelCase — attach_timestamp y attachTimestamp son el mismo campo. Los ejemplos usan camelCase, igual que los SDKs.

Lo que no mandes toma su valor por defecto: recordatorios cada 24 h, archivos adjuntos, aviso a todos, español, y expiración a 14 días.

sticker_pages?array<>

Qué páginas se analizan en busca de recuadros de firma dentro del documento — los rectángulos Firmamex … que puedes dibujar en el PDF mismo en lugar de mandar un arreglo stickers.

Por defecto Firmame analiza las primeras 3 y las últimas 8 páginas. Usa este parámetro cuando tus recuadros estén fuera de ese rango, o para que el análisis sea más rápido acotándolo. Empieza en cero: [0,2,4] son las páginas 1, 3 y 5. Hasta 30 entradas.

La sintaxis de los recuadros está en la guía «Recuadros de firma en el documento».

Elementositems <= 30

document_set?string

Agrega el documento a un expediente abierto en lugar de dejarlo suelto. También se acepta como documentSet.

Así es como entran los documentos a un expediente — no hay un endpoint aparte de «agregar al expediente». Crea el expediente con POST /api/documentset, agrega los documentos aquí, y arranca el flujo con POST /api/documentset/close.

fields?array<>|array<>|

Los placeholders de una plantilla.

La forma depende del tipo de plantilla. Cada tipo lo procesa un motor distinto y Firmame entrega lo que ese motor produjo, sin normalizarlo, así que los fields que lees y los fields que mandas a POST /developers/json siguen la misma forma por tipo:

`template_type`	`fields`
`html`	Arreglo de `{id, value}`
`pdf`	Arreglo de `{key, value, type}`, más `field_options` en los campos de opción
`pdfmake`	Objeto indexado por el nombre de la `{{variable}}`
`docx`	Objeto indexado por el nombre del placeholder

tables?array<>

Renglones para agregar a las tablas dinámicas de una plantilla HTML. Solo tiene sentido con template.

Cuerpo de la respuesta

`application/json`

`text/plain`

curl -X POST "https://example.com/developers/json" \  -H "Content-Type: application/json" \  -d '{    "url_doc": {      "url": "https://ejemplo.com/contrato.pdf",      "name": "contrato.pdf"    },    "stickers": [      {        "authority": "EMAIL_LINK",        "stickerType": "rect",        "dataType": "email",        "imageType": "stroke",        "data": "[email protected]",        "page": 0,        "rect": {          "lx": 330,          "ly": 300,          "tx": 530,          "ty": 400        }      }    ]  }'

{  "document_ticket": "c6279a7c-b3d5-4c71-b417-4687a4f38914",  "document_flow": false,  "sticker_count": 1,  "stickers": [    {      "sticker_id": "qv3ZzAL3w",      "sticker_index": 0,      "sticker_email": "[email protected]",      "sticker_data": "[email protected]",      "sticker_page": 0,      "sticker_coordinates": {        "lx": 388,        "ly": 400,        "ux": 496,        "uy": 480      },      "sticker_type": "EMAIL",      "sticker_image_type": "hash",      "sticker_authorities": [        {          "authority_name": "Vinculada a Correo Electrónico"        }      ]    }  ],  "document_url": "https://app.firmame.com/pdf/c6279a7c-b3d5-4c71-b417-4687a4f38914/?child=true&inv=true"}