API Pública

Diretrizes e recursos para integração com a API Pública do E-Docs.

Visão Geral

O E-Docs disponibiliza uma API robusta para automação de fluxos documentais e processuais. Toda nova integração deve ser realizada utilizando a versão V2.

Endpoints e Ambientes

Ambiente	Base URL	Swagger	JSON Definition
Treinamento	https://api.treinamento.e-docs.es.gov.br	V2.0	swagger.json
Produção	https://api.e-docs.es.gov.br	V2.0	swagger.json

Ambiente recomendado para integração inicial

Sempre inicie testes e homologação no ambiente de Treinamento. A liberação para Produção ocorre após validação pelo time E-Docs.

Política de Versão

• V2 (Vigente): Utilize exclusivamente para novas integrações e atualizações.
• V1 (Descontinuada): Não deve mais ser usada. Caso seu sistema ainda dependa da V1, consulte o guia de Migração.

---

Integrações Complementares

O E-Docs depende de outros serviços estaduais para autenticação e estrutura organizacional:

• Acesso Cidadão: Essencial para autenticação e autorização via OAuth 2.0.
  • API Acesso Cidadão (Swagger)
• Organograma: Utilizado para consulta de estruturas organizacionais (órgãos e setores).
  • API Organograma

---

Primeiros Passos

1. Cadastro: Adicione seu sistema no Acesso Cidadão com fluxos Hybrid/Authorization Code (usuários) e Client Credentials (consultas automatizadas).
2. Solicitação de Acesso: Solicite o acesso para sua aplicação antes de iniciar os testes.
3. Autenticação: Leia a documentação de Autenticação para entender como obter e utilizar os Bearer Tokens e quais escopos solicitar.
4. Consulta ao Organograma: Caso precise consultar o Organograma, inclua o escopo api-organograma na configuração do seu App no Acesso Cidadão.

---

Principais Capacidades da API

Onboarding

• Solicitação de Acesso — como solicitar acesso à API.
• Autenticação — fluxos OAuth 2.0 e escopos.

Documentos

• Upload, fase de assinatura, captura, validação e pesquisa.
• Documentos — fluxo de upload e assinatura.
• Captura — institucionalização de documentos.
• Documento Digitalizado Original — (em testes) captura de digitalizado com valor de original.

Encaminhamentos

• Encaminhamentos — criação, reencaminhamento, resposta e complementação.

Processos

• Processos — autuação, despacho, avocamento, entranhar/desentranhar, edição, encerramento e reabertura.
• Associação — consulta de processos associados.

Restrição de Acesso

• Restrição de Acesso — níveis Público, Organizacional, Sigiloso e Classificado.

Consultas de Apoio

• Consultas — visão geral das consultas disponíveis.
• Agente — patriarcas, organizações, setores, grupos e comissões.
• Classificação Documental — planos e classes ativas.

Migração

• Migração V1 → V2 — orientações para sistemas legados.