API Pública

Integração via API - Guideline

Resumo

Esta documentação fornece diretrizes para a integração com a API Pública do Sistema E-Docs. Aqui você encontrará:

• Métodos Disponíveis: Consulte os métodos disponíveis para utilização via API.
• Ambiente de Treinamento: Utilize o ambiente de treinamento para seus testes.
  • E-Docs Web - Treinamento
  • E-Docs Api - Treinamento

Integrações

O Sistema E-Docs integra-se com os seguintes sistemas:

• Acesso Cidadão: Utilizado para autenticação e autorização de usuários, sua API está disponível em API Acesso Cidadão.
• Organograma: Utilizado para consultar órgãos e setores cadastrados, sua API está disponível em API Organograma.

Primeiros Passos

• Adicionar um sistema no Acesso Cidadão com os fluxos Hybrid/Autorization Code e ClientCredentials.
• Solicitar acesso para sua aplicação antes de utilizar a API do E-Docs ou do Organograma.
• Autenticação - Entenda como funciona a autenticação para utilização da API E-Docs.

Principais Ações do E-Docs

• Documentos: Enviar para assinatura, capturar, assinar, validar, pesquisar.
• Encaminhamentos: Novo, reencaminhar, responder, complementar, pesquisar.
• Processos: Autuar, despachar, avocar, entranhar/desentranhar documentos, editar, encerrar, reabrir, pesquisar.
• Consultas: Informações básicas para preenchimento de cadastros.

O Organograma é utilizado para consultar os Órgãos e Setores nele cadastrados. Atualmente o Organograma possui uma integração com o sistema de Recursos Humanos do Governo do Estado do Espírito Santo, além de dados de várias prefeituras integradas ao E-Docs.

Primeiros passos:

• Adicionar um sistema no Acesso Cidadão
  • Adicionar um App com o fluxo Hybrid, as propriedades destes App serão necessárias para configurar a autenticação dos usuários para que ele possa realizar as operações no E-Docs.
  • Adicionar um App com o fluxo ClientCredentials, as propriedades destes App serão necessárias para que o sistema faça consultas em outros sistemas, por exemplo o organograma.
• Caso seja necessário obter informações do Organograma será necessário acrescentar o scope api-organograma ao App de fluxo ClientCredentials que foi criado no Acesso Cidadão.

Principais ações do E-Docs

• Documentos
  • Enviar documento para fase de assinatura
  • Capturar
  • Assinar
  • Validar arquivos previamente capturado no E-Docs
  • Pesquisar
• Encaminhamentos
  • Novo
  • Reencaminhar
  • Responder
  • Complementar
  • Pesquisar
• Processos
  • Autuar
  • Despachar
  • Avocar
  • Entranhar Documentos
  • Desentranhar Documentos
  • Entranhar Encaminhamentos
  • Editar
  • Encerrar
  • Reabrir
  • Pesquisar
• Informações Básicas
  • Para preenchimento de algumas informações obrigatórias nas ações do E-Docs, pode ser necessário consultar algumas informações.