Todas as páginas
Fornecido por GitBook
1 de 6

Gerenciando documentos

Obter detalhes

Sobre este guia​

Através deste guia, demonstraremos como obter todos os detalhes de um documento através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de obter todos os detalhes de um documento de forma estruturada em uma resposta JSON.

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, 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).

Todos os eventos que ocorrem no ciclo vida de um documento ficam registrados e podem ser recuperados através desta funcionalidade. Este endpoint disponibilza os detalhes de cada documento, assim como todos seus eventos.

Atualmente, os seguintes eventos são armazenados e retornados:

  • Envio do documento para assinatura;

  • Abertura do link do envelope por um assinante;

  • Visualização do documento por um assinante;

  • Assinatura ou recusa do documento por um assinante;

Entenda, a seguir, como chamar nossa API Rest para obter detalhes de seus documentos:

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 familiarizado 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 GET para o endpoint /documents/

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

Abaixo um exemplo da requisição:

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ê deseje gerar as evidências.

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

curl -X 'GET' \
  'https://sign-core-dev.acesso.io/api/v1/service/documents/{{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:

{
  "Url": "https://",
  "UrlVoucher": "https://",
  "DocumentType": "Nome",
  "CreatedDate": "09/04/2022 20:09",
  "EmitterUserName": "Name",
  "EmitterUserEmail": "email@gmail.com",
  "CompanySocialName": "Unico",
  "UUID": "4a95e405-2534-4cf6-aa56-01ddc535bbf4",
  "HasFile": false,
  "Subscribers": [
    {
      "SubscriberName": "Flavia dos Santos",
      "SubscriberCPF": "10000000019",
      "SubscriberEmail": "email@gmail.com",
      "SubscriberPhone": "5513987654321",
      "ID_SubscriberStatus": 108,
      "SubscriberOrder": 1,
      "SubscriberEvents": [
        {
          "EventName": "NotifiedEmail",
          "EventDescription": "O envelope foi enviado via E-mail",
          "EventDates": [
            "2022-09-03T20:20:01.6046578+00:00"
          ]
        },
        {
          "EventName": "EnvelopeOpened",
          "EventDescription": "O link do envelope foi aberto",
          "EventDates": [
            "2022-09-04T15:20:01.6046598+00:00",
            "2022-09-04T16:20:01.6046602+00:00"
          ]
        },
        {
          "EventName": "DocumentViewed",
          "EventDescription": "O documento foi visualizado",
          "EventDates": [
            "2022-09-04T17:20:01.6046608+00:00",
            "2022-09-04T18:20:01.6046614+00:00",
            "2022-09-04T19:20:01.6046616+00:00"
          ]
        },
        {
          "EventName": "DocumentAccepted",
          "EventDescription": "O documento foi aceito",
          "EventDates": [
            "2022-09-04T20:10:01.6046619+00:00"
          ]
        },
        {
          "EventName": "DocumentRefused",
          "EventDescription": "Recusou-se a assinar",
          "EventData": "Os meus dados pessoais estão inválidos.",
          "EventDates": [
            "2024-10-04T13:33:16.210813+00:00"
          ]
        },
        {
          "EventName": "DocumentFinalized",
          "EventDescription": "O processo de assinatura do signatário foi finalizado",
          "EventDates": [
            "2022-09-04T20:15:01.6046622+00:00"
          ]
        }
      ]
    }
  ],
  "IsTemplate": false,
  "DocumentSubcategoryUUID": "af70e1a4-1f8e-432c-b4c1-40b29dfd1aea",
  "DocumentSubcategoryName": "Abertura de conta bancária",
  "DocumentCategoryUUID": "e3529e7f-63cd-4574-a03e-d248f078d8fd",
  "DocumentCategoryName": "Admissão"
}

Cada elemento do objeto SubscriberEvents representa um evento ocorrido no documento, sendo que:

  • O parâmetro EventName representa o nome do evento;

  • O parâmetro EventDescription representa a descrição do evento;

  • O parâmetro EventDates contem uma lista de datas nas quais o evento ocorreu.

Próximos passos​

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Obter arquivo PDF

Sobre este guia​

Através deste guia, demonstraremos como gerar um arquivo PDF a partir de um documento através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de obter um arquivo PDF do documento desejado.

Você já sabe, mas não custa lembrar: Um envelope possui um ou mais documentos. O documento em questão deverá estar dentro de um envelope.

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, 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). Os documentos estão contidos dentro de um envelope, que por sua vez pode conter um ou mais documentos.

Entenda a seguir, como obter um arquivo PDF de um documentos pertencente a um de seus envelopes:

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 familiarizado 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. Somente 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 /file/

Após gerar um token de acesso válido, faça uma requisição para o endpoint de geração de arquivos PDF de nossa API REST (GET/service/file), especificando qual documento deseja como um parâmetro no path da requisição.

Abaixo um exemplo da requisição:

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ê deseje gerar as evidências.

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

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

Se tudo der certo em sua requisição, você receberá como resposta o arquivo binário do PDF.

Próximos passos​

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

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 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, 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 familiarizado 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. Somente 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:

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ê deseje gerar as evidências.

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 correspondente.

Próximos passos​

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Obter evidências

Sobre este guia​

Através deste guia, demonstraremos como recuperar um conjunto de evidências de um documento assinado através de nossas APIs REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de obter um arquivo PDF com o conjunto de evidências.

Envelopes, documentos e evidências

Você já sabe, mas não custa lembrar: Um envelope possui um ou mais documentos. As evidências relacionam-se diretamente aos documentos e não aos envelopes.

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, Evidências servem para comprovar juridicamente a conformidade e validade de um envelope, documento ou assinatura.

Os elementos básicos de um conjunto de Evidências são:

  1. Dados do emissor do envelope;

  2. Dados do envelope (Id e Status);

  3. Dados do documento original (Nome, Id e Hash SHA256 do documento);

  4. Dados dos assinantes;

  5. Dados do documento assinado (Nome, Id e Hash SHA256 da assinatura);

  6. Logs dos eventos ocorridos no envelope.

Entenda a seguir, como obter um arquivo PDF com o conjunto de evidências de um documento já assinado:

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 familiarizado 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. Somente 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

Certifique-se que o documento tem um status válido

O documento de evidências está disponível apenas para os 3 status finais do fluxo de assinaturas: Concluído, recusado ou cancelado. Caso o documento não esteja em um desses formatos, você não conseguirá gerar o arquivo PDF.

Consulta do status

Caso o documento não esteja em um status considerado "final", retornaremos um erro HTTP 500.

import HttpMethod from '@site/src/components/HttpMethod';

Você pode consultar o status dos documentos através do método (GET/service/documents). Saiba mais sobre este método neste guia.

3

Faça uma requisição para o endpoint /evidence/

Após gerar um token de acesso válido, faça uma requisição para o endpoint de geração de evidencias de nossa API REST (GET/service/evidence), especificando o documento ao qual deseja gerar as evidências como um parâmetro no path.

Abaixo um exemplo da requisição:

Não se esqueça de subsctituir o parâmetro DOCUMENT_UUID na requisição abaixo. Este parâmetro deve conter o UUID do documento ao qual você deseje gerar as evidências.

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

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

Se tudo der certo em sua requisição, você receberá como resposta o arquivo binário do PDF.

Próximos passos​

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Obter categorias

Sobre este guia​

Através deste guia, demonstraremos como obter todas as categorias e subcategorias disponíveis de um usuário através de nossa API REST. Ao seguir os passos deste guia, em poucos minutos você será capaz de obter todas as categorias disponíveis em seus documentos em uma resposta JSON.

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, 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).

Cada documento pode ser classificado com uma categorias e subcategoria. Essas categorias são uteis para classificar e identificar facilmente quais IDs correspondem a quais documentos.

Entenda, a seguir, como chamar nossa API Rest para obter suas categorias:

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 familiarizado 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. Somente 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 GET para o endpoint /categories/​

Após gerar um token de acesso válido, faça uma requisição para o endpoint de obtenção de categorias da nossa API REST (GET/service/categories).

Abaixo um exemplo da requisição:

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

Se tudo der certo em sua requisição, você receberá como respota um JSON contendo as categorias com seus documentIds.

{
  "Success": true,
  "Message": "",
  "Data": {
    "Page": 5,
    "Count": 1,
    "DocumentCategories": [
      {
        "DocumentCategoryName": "Admissão",
        "UUID": "00000000-0000-0000-0000-000000000000",
        "DocumentSubcategories": [
          {
            "DocumentSubcategoryName": "Contrato",
            "DocumentCategoryUUID": "dad4bfa9-a993-492d-953e-d412d2d185f3",
            "UUID": "00000000-0000-0000-0000-000000000000"
          },
          {
            "DocumentSubcategoryName": "Exame médico",
            "DocumentCategoryUUID": "dad4bfa9-a993-492d-953e-d412d2d185f3",
            "UUID": "00000000-0000-0000-0000-000000000000"
          }
        ]
      }
    ]
  }
}

Próximos passos​

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.