Pular para o conteúdo principal

Captura

Integração via API - Documentos

Registro do documento e captura​

Nesse passo você deverá dar continuidade aos passos anteriores de upload do arquivo a ser registrado.

Ao fim desse passo você terá posse do identificador do evento de captura que foi enfileirado.

Há diferentes tipos de etapas, de acordo com o tipo de documento enviado:

Se for arquivo nato-digital e com assinatura digital E-Docs​

Arquivo nato-digital é um arquivo originado a partir de um documento digital, tal como suítes de escritório, e exportado para PDF.

Nesse caso, haverá multiplos assinantes, ou há um assinante, mas este não é o capturador, portanto as assinaturas serão realizadas em um momento posterior, através de endpoints específicos.

Em caso de o documento em fase de assinatura ter sido criado por um cidadão, todos os assinantes devem ser cidadãos.

Portanto, o primeiro endpoint é o de envio do identificador do arquivo criado na nuvem constante no JSON retornado na etapa anterior, tal qual das informações do Documento, conforme descrito aqui se for um servidor ou aqui se for um cidadão.

Para maiores informações sobre restrição de acesso clique aqui

Registrado o documento em fase de assinatura, o retorno será um identificador de documento em fase de assinatura.

Nesse momento, em posse desse identificador, os usuários assinantes devem - autenticados com seus respectivos Access Tokens - realizar a assinatura conforme descrito aqui.

Com a última manifestação de assinante realizada o documento é capturado e o retorno do endpoint de assinatura retorna capturado como true e idCapturaEvento retorna o identificador do evento de captura que foi enfileirado.

Se for arquivo nato digital e com apenas a assinatura digital E-Docs do Capturador​

Arquivo nato-digital é um arquivo originado a partir de um documento digital, tal como suítes de escritório, e exportado para PDF.

Nesse caso, haverá apenas um assinante, e este é o próprio capturador, portanto a assinatura serão realizada automaticamente.

Assim, o endpoint receberá o identificador do arquivo criado na nuvem constante no JSON retornado na etapa anterior, tal qual as informações do Documento, conforme descrito aqui se for um servidor ou aqui se for um cidadão.

Para maiores informações sobre restrição de acesso clique aqui

Registrado o documento, o E-Docs automaticamente irá acrescentar o Capturador como assinante, já realizando também essa etapa.

Por fim é realizada a captura e retorna-se o identificador do evento de captura que foi enfileirado.

Para todos os outros casos​

Aqui se engloba os tipos de arquivo:

  • Arquivo nato-digital, que é um arquivo originado a partir de um documento digital, tal como suítes de escritório, e exportado para PDF.
    • Se o arquivo nato-digital é apenas uma cópia, sem nenhuma assinatura;
    • Se o arquivo nato-digital foi previamente assinado por uma assinatura digital padrão ICP-Brasil.
  • Arquivo digitalizado, que é um arquivo originado a partir de um documento físico em papel, digitalizado por foto ou dispositivo digitalizador de documentos tal qual scanner, no formato PDF.

Assim, será enviado o identificador do arquivo criado na nuvem constante no JSON retornado na etapa anterior, tal qual as informações do Documento, para o endpoint mais adequado:

Para maiores informações sobre restrição de acesso clique aqui.

Por fim é realizada a captura e retorna-se o identificador do evento de captura que foi enfileirado.

Captura do Documento​

A captura do Documento é a forma de institucionalizá-lo e fazer com que ele possa ser utilizado dentro do E-Docs.

Na etapa anterior, o Documento foi categorizado quanto à sua Natureza, Valor Legal e Gênero

Natureza:

  • Nato-digital;
  • Digitalizado

Valor Legal:

  • Original;
  • Cópia Autenticada Administrativamente;
  • Cópia Simples

Gênero:

  • Textual (único aceito pela API);
  • Áudio;
  • Vídeo

Como explicitado na etapa anterior, ao enviar o documento para captura, ele é encapsulado em um evento, que fica enfileirado aguardando o seu momento para ser executado.

Com a posse do identificador você pode consultar se o evento já foi executado, retornando o identificador do documento que foi capturado, conforme o end point descrito aqui.

Documento capturado​

Após um Documento ser capturado ele poderá ser consultado, validado, entre outros.

Destacamos entre os demais endpoints:

  • Pode usar: se o usuário tem permissão para usar esse documento em processos, encaminhamentos, etc. Clique aqui.
  • Validação de Assinatura Digital: Verifica se um arquivo contem assinatura digital e que essa atende a todos os parâmetros validados pelo E-Docs. Ele não valida a veracidade do conteúdo, apenas o armazenamento no E-Docs. Clique aqui.

Para os demais endpoints, consultar a documentação completa aqui.

Informações complementares para preenchimento​

Abaixo as informações básicas necessárias para o preenchimento de cadastros de Documentos:

Para buscar patriarcas, órgãos, setores, grupos de trabalho e comissões, utilize esses endpoints.

Para buscar planos ativos e classes ativas, utilize esses endpoints.

Para buscar fundamentos legais, utilize esse endpoint.

Para buscar informações do usuário logado, utilize esses endpoints.

Clique aqui para maiores informações.