Skip to main content

Reenviar envelopes

Sobre este guia

Através deste guia, demonstraremos como reenviar um envelope através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de reenviar um envelope a partir de seu UUID.

O que você vai precisar

Antes de iniciar sua integração:

  1. Certifique-se que você possui credenciais válidas para utilizar o Unico Sign. Se você ainda não possui suas credenciais, siga nosso guia de Primeiros Passos para configurar sua conta de teste e obter suas chaves de API.
  2. Entenda os conceitos básicos sobre nosso produto. É extremamente importante que você entenda estes conceitos para fazer uma boa utilização das APIs do Unico Sign. Você pode encontrar nossos conceitos básicos neste guia.

Funcionamento básico

Como explicamos em nosso guia de conceitos básicos, nossa entidade Envelope (envelope) é a representação virtual de um envelope com documentos na vida real. Ele é o objeto que agrupa todos os documentos (document) e seus assinantes (subscriber), sendo que um envelope pode conter mais de documento, que por sua vez pode conter um ou mais assinantes.

Disponibilizamos este end-point para reenviar os envelopes (ainda pendentes de assinatura) para seus assinantes, podendo inclusive informar um novo e-mail ou telefone.

Fluxo de assinatura dentro de um frame

Envelopes criados com a opção isFrame=True não podem ser reenviados.

Entenda, a seguir, como chamar nossa API REST para reenviar um envelope.

  1. Obtenha um token OAuth válido;

    Para efetuar requisições à nossa API REST você necessitará de um token de acesso OAuth válido. Caso não esteja familizarizado com o modelo de autenticação OAuth, entenda como gerar um token válido neste artigo. Após sua geração, o token de acesso deverá ser enviado no header de sua requisição, junto ao parâmetro Authorization.

    Ambientes

    Ao iniciar sua integração você receberá credenciais a nosso ambiente de homologação. Sómente após o processo de testes e certificação você receberá credenciais de produção.

    Você deverá apontar suas requisições às URLs corretas em cada estágio de sua integração. Abaixo listamos as URLs de homologação e produção:

    • Ambiente de homologação: https://signhom.acesso.io;
    • Ambiente de produção: https://sign.acesso.io.
  2. Faça uma requisição POST para o endpoint /resend/

    Após gerar um token de acesso válido, faça uma requisição para o endpoint de reenvio de envelopes da nossa API REST (POST/service/resend) enviando os parâmetros conforme o schema abaixo:

    UUID
    string <uuid>

    Identificador do envelope que será reenviado

    • O envelope deve estar no status pendente
    Array of objects or null (ResendEnvelopeRequest_Subscriber)

    Lista de Subscribers do envelope

    {
    • "UUID": "dad4bfa9-a993-492d-953e-d412d2d185f3",
    • "Subscribers": [
      ]
    }
    Permissão para Enviar Documentos

    Para utilizar esta rota é necessário que o usuário tenha permissão de Enviar Documentos

    Abaixo um exemplo de como reenviar um um envelope com o UUID igual a 00000000-0000-0000-0000-000000000000, atualizando as informações de Subscribers.

    curl -X 'POST' \
    'https://sign-core-dev.acesso.io/api/v1/service/resend' \
    -H 'accept: */*' \
    -H 'Content-Type: application/json' \
    -d '{
    "UUID": "00000000-0000-0000-0000-000000000000",
    "Subscribers": [
    {
    "SubscriberUUID": "00000000-0000-0000-0000-000000000000",
    "SubscriberEmail": "test@test.com",
    "SubscriberPhone": "5511988888888"
    }
    ]
    }'

    Se tudo der certo em sua requisição, você receberá como resposta um código HTTP 200, que confirma o reenvio de seu envelope.

    API Reference

    Aprenda mais sobre este endpoint em nosso API Reference.

Próximos passos

Ficou com dúvidas?

Esperamos ter ajudado com este artigo. Não encontrou algo ou ainda precisa de ajuda?