eSign.AIeSign.AI
Centro de desarrolladores

Crear sobre

POST /esignglobal/v1/envelope/create

Descripción de la interfaz

Crear un sobre en estado de borrador.

Parámetros de solicitud

Nombre del parámetro

Tipo

Obligatorio

Descripción

subject

string

true

Asunto del sobre, ejemplo: "Carta de oferta"

remark

string

false

Notas del sobre, límite de longitud de 1000 caracteres

signerSettings

object

false

Operaciones permitidas para el firmante

 

allowTransfer

boolean

false

Si se permite que el firmante transfiera este sobre a otra persona para su firma, por defecto false

true- Se permite que los firmantes dentro del sobre tengan la facultad de transferir el sobre a otras personas;

false- No se permite que los firmantes dentro del sobre tengan la facultad de transferir el sobre a otras personas;

 

allowModifyName

boolean

false

Si se permite que la parte firmante modifique su nombre, solo aplica a las firmas de plantillas, por defecto false

true- Se permite al firmante modificar su nombre

false-No se permite que el firmante modifique su nombre

tspScope

array

false

Ámbito TSP a nivel de sobre, valor predeterminado false.

Una vez especificado, al agregar un firmante, se debe seleccionar el TSP que el firmante necesita utilizar dentro del ámbito especificado. Los valores de enumeración incluyen:

vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni、belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia、estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom、harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId、mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign、smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe、certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha。

expireAfterSeconds

long

false

Hora de vencimiento del sobre: después de cuántos segundos expira el sobre

Rango de vencimiento: de 86.400 segundos (1 día) a 7.776.000 segundos (90 días).

redirectUrl

string

false

URL de redirección tras completar la firma (longitud 2048), debe ser una dirección http válida

callBackUrl

string

false

URL de devolución de llamada (longitud 500), debe cumplir con el protocolo https/http

Ejemplo de solicitud

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "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-Firmado

2-Completado

3-Vencido

5-Anulado

Ejemplo de respuesta

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}