POST /esignglobal/v1/envelope/create
Descripción de la interfaz
Crea un sobre en estado de borrador.
Parámetros de solicitud
Nombre del parámetro | Tipo | ¿Requerido? | Descripción |
subject | string | true | Asunto del sobre, ejemplo: “Carta de Oferta” |
remark | string | false | Notas del sobre, longitud máxima de 1000 caracteres |
signerSettings | object | false | Operaciones permitidas para el firmante |
| allowTransfer | boolean | false | Indica si se permite que el firmante transfiera este sobre a otra persona para que lo firme, el valor predeterminado es falso true-Permite que el firmante del sobre tenga el poder de transferir el sobre a otros; false-No permite que el firmante del sobre tenga el poder de transferir el sobre a otros; |
| allowModifyName | boolean | false | Indica si se permite que el firmante modifique el nombre, solo es efectivo para la firma de la plantilla, el valor predeterminado es falso true-Permite que el firmante modifique el nombre false- No se permite que el firmante modifique el nombre |
expireAfterSeconds | long | false | Tiempo de expiración del sobre: después de cuántos segundos expira el sobre Rango de expiración: 86,400 segundos (1 día) ~ 7,776,000 segundos (90 días). |
redirectUrl | string | false | Dirección de redireccionamiento al completar la firma (longitud 2048), debe ser una dirección http válida |
callBackUrl | string | false | Dirección de callback (longitud 500), debe ser una dirección de protocolo https / http |
Ejemplo de solicitud
{
"subject": "api subject fdsfasdfafs",
"remark": "This is a remark",
"expireAfterSeconds": 888640,
"redirectUrl": "https://www.example.com"
}
Parámetros de respuesta
Nombre del parámetro | Tipo | Descripción |
envelopeId | string | ID del sobre |
envelopeStatus | int | Estado del sobre 0 - Creado (borrador) 1 - En proceso de firma 2 - Completado 3-Caducado 5-Revocado |
Ejemplo de respuesta
{
"code": "0",
"data": {
"envelopeId": "9fbe6c8190824227bde29136b0145c81",
"envelopeStatus": 0
},
"message": "success"
}
