Pular para o conteúdo principal

Obter dados de modelo

Sobre este guia​

Através deste guia, demonstraremos como obter dados preenchidos em um documento gerado a partir de um modelo através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de obter todos os dados inseridos pelos usuários em seus documentos.

O que você vai precisar​

Antes de iniciar sua integração:

  1. Certifique-se que você possui credenciais válidas para utilizaro Unico Sign. Se você ainda não suas credenciais, siga nosso guia de Primeiros Passos para configurar sua conta de teste e obter sua 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, Documentos (document) são a representação virtual de um documento que deve ser assinado (por um ou mais assinanates) e pode ser gerado a patir de um arquivo PDF ou de um modelo (Template). Documentos gerados a partir de template podem possuir campos preenchíveis pelos usuários que irão assinar o documento.

Entenda a seguir, como obter dados preenchidos por um assinante em documentos gerados a partir de um modelo:

  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 para o endpoint /templatedata/​

    Após gerar um token de acesso válido, faça uma requisição para o endpoint de obtenção dos dados do template na nossa API REST (GET/service/templatedata), especificando qual documento deseja como um parâmetro no path da requisição.

    Abaixo um exemplo da requisição:

    Document UUID

    Não se esqueça de substituir o parâmetro DOCUMENT_UUID na requisição abaixo. Este parâmetro deve conter o UUID do documento ao qual você deseja visualizar os dados do template enviado.

    Exemplo de formato de um UUID: 00000000-0000-0000-0000-000000000000

    curl -X 'GET' \
      'https://sign-core-dev.acesso.io/api/v1/service/templatedata/{{DOCUMENT_UUID}}' \
      -H 'accept: application/pdf' \
      -H 'Authorization: Bearer {{ACCESS_TOKEN}}'

    Se tudo der certo em sua requisição, você receberá como respota um JSON contendo uma lista com os campos do template:

    {
        "Success": true,
        "Message": "",
        "Data": {
            "UUID": "d610d146-d658-428c-9c63-2067807fb22a",
            "TemplateFields": [
                {
                    "FieldCode": "CampoTextBox",
                    "FieldValue": "Reposta Modelo"
                },
                {
                    "FieldCode": "CampoCheckBox1",
                    "FieldValue": "1"
                },
                {
                    "FieldCode": "CampoRadioATrue",
                    "FieldValue": "0"
                },
                {
                    "FieldCode": "CampoRadioAFalse",
                    "FieldValue": "1"
                }
            ]
        }
    }

    Cada elemento do objeto TemplateFields representa um campo no template, sendo que:

    • O parâmetro FieldCode representa o nome do campo;
    • O parâmetro FieldValue representa o valor preenchido no campo correpondente;

Próximos passos​

Ficou com dúvidas?​

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