¿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 la firma utilizando una plantilla con la Sign.Plus eSignature API.
Siguiendo estos pasos, crearás un sobre a partir de una plantilla, establecerás los detalles del destinatario y enviarás el sobre para la firma.
Prerrequisitos
- Una cuenta de Sign.Plus con un Plan API
- Your
Personal Access Token
- An existing template in your Sign.Plus account
Paso 1: Crear un sobre a partir de una plantilla
- Utilice el endpoint POST /v2/envelope/from_template/{template_id} para crear un nuevo sobre desde una plantilla.
- Reemplazar
{template_id}
con el ID de tu plantilla existente.
¿Dónde puedo encontrar mi ID de plantilla?- Ve a https://app.sign.plus/templates.
- Haga clic en el nombre de la plantilla deseada.
- Copia el ID de la barra lateral derecha.
- Ve a https://app.sign.plus/templates.
- Envía una solicitud POST a
POST /v2/envelope/from_template/{template_id}
con el siguiente cuerpo JSON:{
"name": "Mi maravilloso sobre de la plantilla"
} - Incluya su clave API en el encabezado
Autorización
. - En caso de éxito, recibirás
un objeto
.{
"id": "66eb7d0467d2d549b89fcb6d",
// ...
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"uid": null,
"name": "",
"email": "",
"role": "SIGNER",
"verification": null
}
]
},
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb71",
"uid": null,
"name": "",
"email": "",
"role": "RECEIVES_COPY",
"verification": null
},
{
"id": "66eb7d0467d2d549b89fcb72",
"uid": null,
"name": "",
"email": "",
"role": "SIGNER",
"verification": null
}
]
}
],
"documents": [
// ...
],
"notification": {
// ...
}
} - Guarda el identificador devuelto
id
comoenvelope_id
para futuras llamadas API. - Registra la
id
de cada destinatario para su uso posterior en el proceso de firma.
Ejemplos:-
66eb7d0467d2d549b89fcb71
: PrimeraSIGNER
(Paso 1) -
66eb7d0467d2d549b89fcb71
:RECEIVES_A_COPY
(Paso 1) -
66eb7d0467d2d549b89fcb72
: SegundoSIGNER
(Paso 2)
-
Paso 2: Configurar detalles del destinatario
Si su plantilla no tiene destinatarios fijos y necesita establecer o actualizar los detalles del destinatario:
- Utilice el endpoint POST /v2/envelope/{envelope_id}/signing_steps para actualizar la información del destinatario.
- Reemplaza
{envelope_id}
con el ID que recibiste en el paso 1. - Envía una solicitud
POST
con el siguiente cuerpo JSON:{
"signing_steps": [
{
"destinatarios": [
{
"id": "66eb7d0467d2d549b89fcb70",
"nombre": "John Doe",
"email": "john. oe@ejemplo. om",
"rol": "SIGNER"
}
]
},
{
"destinatarios": [
{
"id": "66eb7d0467d2d549b89fcb71",
"nombre": "Mark Twain",
"email": "m. wain@ejemplo. om",
"rol": "RECEIVES_COPY"
},
{
"id": "66eb7d0467d2d549b89fcb72",
"nombre": "Jane Smith",
"email": "j. mith@ejemplo. om",
"rol": "SIGNER"
}
]
}
]
} - En caso de éxito, recibirás un array de objetos
SigningStep
.
Paso 3: 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 sobres del paso 1. - Envía una solicitud
POST
a este extremo. - En caso de éxito, el sobre será enviado al destinatario (s) para su firma.
Conclusión
Ahora ha enviado con éxito un documento para la firma utilizando una plantilla con la API Sign.Plus de eSignature. El destinatario(s) recibirá una notificación por correo electrónico con un enlace para firmar el documento.
El uso de plantillas puede transmitir significativamente el flujo de trabajo de su documento, especialmente para documentos usados con diseños consistentes y requisitos de firma.