Pular para o conteúdo principal

Captura

Endpoints para institucionalização e registro final de documentos no E-Docs.

Fluxo de Integração

A captura ocorre após o upload físico do arquivo. O fluxo depende da natureza e do tipo de assinatura do documento:

  1. Envio de Metadados: Chamada do endpoint específico conforme o tipo de documento.
  2. Fase de Assinatura (se aplicável): Manifestação dos assinantes.
  3. Enfileiramento: E-Docs processa a captura e retorna um idEvento.
  4. Consulta: Uso do endpoint de eventos para obter o ID do documento capturado.

Tipos de Registro​

1. Nato-Digital com Assinatura Eletrônica (E-Docs)​

Documentos originados digitalmente que exigem manifestação de múltiplos assinantes (ou assinatura posterior, caso o capturador não seja um assinante).

Regras Específicas:

  • Se o documento foi criado por um cidadão, todos os assinantes devem ser cidadãos.
  • O capturador informa o ID do arquivo (nuvem) e metadados.
  • Para restrição de acesso, consulte /api/RestricaoAcesso.
  • Após o registro, os usuários assinantes devem utilizar o endpoint de assinatura.
  • Com a última manifestação (assinatura ou recusa), o documento é capturado. O retorno do endpoint de assinatura retorna capturado: true e idCapturaEvento (identificador do evento de captura enfileirado).

2. Nato-Digital com Assinatura do Capturador​

Assinado automaticamente pelo responsável pelo registro (único assinante).

Regras Específicas:

  • O E-Docs adiciona automaticamente o Capturador como assinante, realizando o processo de assinatura imediatamente.
  • Para restrição de acesso, consulte /api/RestricaoAcesso.
  • Por fim, é realizada a captura e retornado o identificador do evento de captura enfileirado.

3. Outros Casos​

Inclui Nato-digital cópia, Nato-digital assinado ICP-Brasil ou documentos digitalizados.

Regra Geral:

Informações Complementares​

Na etapa de registro, o Documento é categorizado conforme:

  • Natureza: Nato-digital ou Digitalizado.
  • Valor Legal: Original, Cópia Autenticada Administrativamente ou Cópia Simples.
  • Gênero: Textual (PDF). Áudio e Vídeo estão disponíveis apenas pela interface web do E-Docs.

Operações Pós-Captura​

Exemplos de payload​

Ilustrativo

Os exemplos abaixo apresentam o formato geral dos payloads. Campos exatos, obrigatórios e tipos estão definidos no Swagger V2.

Capturar nato-digital com Assinatura do Capturador (servidor)​

POST /v2/documentos/fase-assinatura/enviar/servidor
Authorization: Bearer {token}
Content-Type: application/json
{
  "idArquivo": "8f9a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
  "idPapel": "11111111-2222-3333-4444-555555555555",
  "idClasseDocumental": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "resumo": "Memorando de solicitação de equipamento",
  "valorLegal": "Original",
  "natureza": "NatoDigital",
  "genero": "Textual",
  "restricaoAcesso": {
    "transparenciaAtiva": true
  }
}

Resposta (202 Accepted):

{
  "idEvento": "f1e2d3c4-b5a6-9876-5432-1f0e9d8c7b6a",
  "capturado": true,
  "idCapturaEvento": "c1d2e3f4-a5b6-7890-1234-567890abcdef"
}

Capturar nato-digital com múltiplos assinantes (servidor)​

POST /v2/documentos/capturar/nato-digital/auto-assinado/servidor
{
  "idArquivo": "8f9a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
  "idPapel": "11111111-2222-3333-4444-555555555555",
  "idClasseDocumental": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "resumo": "Termo de cooperação",
  "valorLegal": "Original",
  "natureza": "NatoDigital",
  "assinantes": [
    { "tipo": "Servidor", "idPapel": "22222222-...." },
    { "tipo": "Servidor", "idPapel": "33333333-...." }
  ],
  "restricaoAcesso": {
    "transparenciaAtiva": false
  }
}

Após o registro, cada assinante deve manifestar-se via endpoint de assinatura. A última manifestação dispara a captura.

Acompanhar a captura (consulta de evento)​

GET /v2/eventos/{idEvento}
Authorization: Bearer {token}

Resposta (após execução):

{
  "idEvento": "f1e2d3c4-...",
  "tipo": "CapturaDocumento",
  "status": "Executado",
  "idDocumento": "9b8a7c6d-5e4f-3a2b-1c0d-eeeeffff0000"
}

Recursos Auxiliares​