Este artículo le guiará a través del proceso de enviar un documento para firma utilizando la API de firma electrónica de Sign.Plus.
Siguiendo estos pasos, creará un sobre, añadirá un documento, configurará un destinatario, insertará una anotación de firma y, finalmente, enviará el sobre para su firma.
Requisitos previos
- Una cuenta de Sign.Plus con un plan de API
- Su
Personal Access Token
Paso 1: Crear un sobre
Un sobre es un contenedor para los documentos que serán firmados por los destinatarios.
- Envíe una solicitud al endpoint POST /v2/envelope para crear un sobre.
{
"name": "My wonderful envelope",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - Incluya su clave de API en el encabezado
Authorization. -
Si la solicitud se realiza correctamente, recibirá un objeto
Envelope.{ "id": "<string>" ... } -
Guarde el
idcomoenvelope_id
Paso 2: Añadir un documento a su sobre
-
Utilice el endpoint POST /v2/envelope/{envelope_id}/document para añadir un documento.
-
Sustituya
{envelope_id}por el ID que recibió en el paso 1. - Envíe una solicitud POST con el archivo del documento en el cuerpo de la solicitud como
multipart/form-data. -
Si tiene éxito, recibirá un objeto
Documentcomo respuesta.{ "id": "<string>" ... } -
Guarde el
idcomo eldocument_idpara más adelante.
Paso 3: Definir un destinatario para su sobre
-
Utilice el endpoint POST /v2/envelope/{envelope_id}/signing_steps para añadir un destinatario.
-
Sustituya
{envelope_id}por el ID de su sobre. -
Envíe una solicitud
POSTcon el siguiente cuerpo JSON:{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john.doe@example.com", "role": "SIGNER"
} ] } ] } -
Si la operación se realiza correctamente, recibirá un array de
SigninStep. -
Recorra el array y anote el nombre
iddel destinatario para el que desea añadir el marco de firma (anotación de firma). Guarde esteidcomo elrecipient_id.
Paso 4: Insertar una anotación de firma en su documento
Antes de añadir una anotación de firma, asegúrese de haber definido su firma en la plataforma de Sign.Plus.
- Utilice el endpoint POST /v2/envelope/{envelope_id}/annotation para añadir una anotación de firma.
- Sustituya
{envelope_id}por el ID de su sobre. - Envíe una solicitud
POSTcon el siguiente cuerpo JSON:{
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}Sustituya
<recipient_id>y<document_id>por los valores correspondientes.
Paso 5: Enviar su sobre para firma
- Utilice el endpoint POST /v2/envelope/{envelope_id}/send para enviar el sobre.
- Sustituya
{envelope_id}por el ID de su sobre. - Envíe una solicitud
POSTa este endpoint. - Si la operación se realiza correctamente, el sobre se enviará al destinatario para su firma.
Conclusión
Ha enviado con éxito un documento para firma utilizando la API de firma electrónica de Sign.Plus. El destinatario recibirá una notificación por correo electrónico con un enlace para firmar el documento.
Para obtener información más detallada sobre cada endpoint de la API utilizado en este proceso, consulte nuestra documentación de la API.