Criar envelope

POST /esignglobal/v1/envelope/create

Descrição da interface

Criar um envelope em estado de rascunho.

Parâmetros de solicitação

Nome do parâmetro		Tipo	Obrigatório	Descrição
subject		string	true	Assunto do envelope, exemplo: "Carta de Oferta"
remark		string	false	Observações do envelope, limite de 1000 caracteres
signerSettings		object	false	Operações permitidas para o signatário
	allowTransfer	boolean	false	Se permite que o signatário transfira o envelope para outra pessoa assinar, padrão false true- Permite que os signatários no envelope tenham o poder de transferi-lo para outras pessoas; false- Não permite que os signatários no envelope tenham o poder de transferi-lo para outras pessoas;
	allowModifyName	boolean	false	Se permite que a parte signatária modifique o nome, aplica-se apenas à assinatura por modelo, padrão false true- Permite que o signatário modifique o nome false-O signatário não pode modificar o nome
tspScope		array	false	Escopo TSP de nível envelope, padrão false. Após a especificação, ao adicionar um signatário, é necessário selecionar o TSP que o signatário utilizará dentro do escopo especificado. Os valores enumerados incluem: 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	Tempo de expiração do envelope: número de segundos após os quais o envelope expira Intervalo de expiração: de 86.400 segundos (1 dia) a 7.776.000 segundos (90 dias).
redirectUrl		string	false	URL de redirecionamento após conclusão da assinatura (comprimento máximo de 2048 caracteres), deve ser um endereço HTTP válido
callBackUrl		string	false	URL de callback (comprimento máximo de 500 caracteres), deve estar em conformidade com os protocolos HTTPS/HTTP

Exemplo de solicitação

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

Parâmetros de resposta

Nome do parâmetro

Tipo

Descrição

envelopeId

string

ID do envelope

envelopeStatus

int

Status do envelope

0-Criado (rascunho)

1-Assinatura em andamento

2-Concluído

3-Expirado

5-Revoogado

Exemplo de resposta

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