¿Quién puede usar esta característica?
Disponible en todos los Developer APIplanes.
Todos los miembros
Este artículo le guiará a través del proceso de envío de un documento para su firma usando la Sign.Plus eSignature API.
Siguiendo estos pasos, usted creará un sobre, agregará un documento, establecerá un destinatario, insertará una anotación de firma y finalmente enviará el sobre para la firma.
Prerrequisitos
- Una cuenta de Sign.Plus con un Plan API
- Your
Personal Access Token
Paso 1: Crear un Sobre
Un sobre es un contenedor para documentos firmados por los destinatarios.
- Envía una solicitud al endpoint POST /v2/envelope para crear un nuevo sobre.
{
"name": "My wonderful envelope",
"flow_type": "REQUEST_SIGNATURE",
"legality_level": "SES",
"expires_at": 1831280113,
"sandbox": true
} - Incluya su clave API en el encabezado
Autorización
. -
En caso de éxito, recibirás un objeto
sobre
.{ "id": "<string>" ... }
-
Ahorra la
id
comoensobope_id
Paso 2: Añade un documento a tu sobre
-
Utilice el endpoint POST /v2/envelope/{envelope_id}/document para añadir un documento.
-
Reemplaza
{envelope_id}
con el ID que recibiste en el paso 1. - Envía una solicitud POST con el archivo de documento en el cuerpo de la solicitud como
multiparte/form-data.
-
En caso de éxito, recibirás un objeto
Document
como respuesta.{ "id": "<string>" ... }
-
Ahorra la
id
como ladocument_id
para más adelante.
Paso 3: Establezca un destinatario para su sobre
-
Utilice el endpoint POST /v2/envelope/{envelope_id}/signing_steps para añadir un destinatario.
-
Reemplaza
{envelope_id}
con tu ID de sobre. -
Envía una solicitud
POST
con el siguiente cuerpo JSON:{
"signing_steps": [
{
"recipients": [
{
"name": "John Doe", "email": "john. oe@ejemplo. om", "rol": "SIGNER"
} ] } ] } -
En caso de éxito, recibirás un array de
SigninStep
. -
Navega por la matriz y toma el nombre
id
del destinatario para el cual quieres añadir el marco de firma (anotación de firma). Guarde esteid
comodestinatario_id
.
Paso 4: Inserte 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 Sign.Plus.
- Utilice el endpoint POST /v2/envelope/{envelope_id}/annotation para añadir una anotación de firma.
- Reemplaza
{envelope_id}
con tu ID de sobre. - Send a
POST
request with the following JSON body:{
"recipient_id": "<recipient_id>",
"document_id": "<document_id>",
"page": 1,
"x": 50,
"y": 20,
"width": 20,
"height": 60,
"required": true,
"type": "SIGNATURE",
}Reemplazar
<recipient_id>
y<document_id>
por los valores apropiados.
Paso 5: Envía tu sobre para la firma
- Usa el endpoint POST /v2/envelope/{envelope_id}/send para enviar el sobre.
- Reemplaza
{envelope_id}
con tu ID de sobre. - Envía una solicitud
POST
a este extremo. - En caso de éxito, el sobre será enviado al destinatario para su firma.
Conclusión
Ahora ha enviado con éxito un documento para su firma utilizando la API de Sign.Plus eSignature. 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 API utilizado en este proceso, consulte nuestra documentación API.