Solicitação de Acesso

Antes de iniciar os testes, é necessário solicitar as permissões para sua aplicação. O processo é diferente para o E-Docs e para o Organograma.

Quem pode solicitar

Toda aplicação integrada ao E-Docs tem como titular um órgão da Administração Pública Estadual. O cadastro no Acesso Cidadão e a liberação dos escopos da API pressupõem esse órgão responsável, ainda que o sistema seja desenvolvido e operado por terceiros (entidade privada, instituição de ensino ou pesquisa, escritório). Não há cadastro de aplicação desvinculado de um órgão.

O órgão titular responde por:

• guardar as credenciais (client_id e client_secret);
• definir e manter os escopos autorizados;
• bloquear a aplicação, se necessário;
• ser o canal de comunicação para avisos de atualização, migração de versão e descontinuidade da API;
• definir quem tem acesso à aplicação e ao conteúdo que ela processa, incluindo a concessão, a revisão periódica e a revogação das permissões das pessoas envolvidas.

O PRODEST provê o meio técnico e a rastreabilidade das operações, e não avalia o mérito da concessão.

Uso direto pela sociedade

A API é voltada à integração dos próprios órgãos em seus processos de negócio. Não existe política específica de uso direto pela sociedade (direitos, acessos, limites). Também não há previsão normativa para credenciar o sistema de uma pessoa jurídica de direito privado, nem para dar a ele acesso ao ambiente de Treinamento. Uma proposta de mudança nesse sentido deve ser levada à GPP/SEGER, que é a área competente para tratar de política de acesso; ela excede a competência do PRODEST, que atua como responsável técnico da plataforma.

Quem só quer acompanhar o andamento de processos pode usar os Favoritos do próprio E-Docs, sem integração.

Acesso a sistemas e acesso a pessoas

O acesso à API é concedido a sistemas, e não a pessoas. A integração é feita por uma equipe técnica, em geral a área de TI do órgão responsável pelo sistema. Quem precisa apenas de um relatório ou de uma consulta pontual deve procurar essa equipe.

A captura e o encaminhamento por cidadão autenticado no Acesso Cidadão, com a própria identidade, são suportados pela API V2. Isso não dispensa o órgão titular: o sistema que faz a chamada continua precisando de um órgão responsável.

O que a API não oferece

• Acesso direto à base de dados: o E-Docs não conecta a base a ferramentas de BI (como o Power BI), porque ela é compartilhada por todo o Estado e por diversos municípios, com controle de acesso por credenciamento e documentos que podem ter conteúdo sigiloso. Para alimentar um painel, um sistema credenciado consulta processos pelo número de protocolo (situação, data de autuação e localização atual) com o escopo api-sigades-consultar, no fluxo client_credentials, e a integração é feita por uma equipe técnica do órgão.
• Extrato de processos e encaminhamentos por setor ou servidor: não existe relatório com número do E-Docs, data de recebimento, tema e responsável. Uma sugestão de melhoria que sirva a todos os usuários vai pelo ponto focal do órgão; uma necessidade mais específica pode ser atendida por consultas montadas pela API.
• Leitura ampla do acervo de um órgão: veja O que cada fluxo enxerga.

Pré-requisito: Cadastro do sistema no Acesso Cidadão

Caso seu sistema ainda não esteja cadastrado no Acesso Cidadão, solicite o cadastro pelo E-Flow antes de prosseguir. O cadastro gera o slug e as credenciais (client_id / client_secret) necessários para as etapas seguintes.

O pedido de acesso à API só é analisado depois do cadastro. Uma solicitação com o campo do slug em branco indica que essa primeira etapa ainda não foi cumprida.

Integração com API E-Docs

Abra uma solicitação pelo E-Flow informando:

• Slug do sistema no Acesso Cidadão (AC): [slug_do_sistema_no_acesso_cidadao]
• O sistema irá capturar documentos?: (Sim/Não). Libera o escopo api-sigades-documento
• O sistema irá encaminhar documentos?: (Sim/Não). Libera o escopo api-sigades-encaminhamento
• O sistema irá fazer atos processuais?: (Sim/Não). Libera o escopo api-sigades-processo
• O sistema irá consultar dados públicos?: (Sim/Não). Libera o escopo api-sigades-consultar

Próximos passos

Após o envio, o time de desenvolvimento do E-Docs analisará a solicitação e concederá as permissões no Acesso Cidadão. Você será notificado quando o acesso estiver disponível para testes.

Peça só o que o sistema vai usar

Cada operação corresponde a um conjunto de permissões. Informe apenas as operações de que o sistema precisa. Uma integração de consulta, por exemplo, só precisa do escopo api-sigades-consultar.

Ambiente de Treinamento e Produção

O desenvolvimento e a homologação são feitos no ambiente de Treinamento (https://api.treinamento.e-docs.es.gov.br), que tem base independente da Produção e não contém dados reais. A equipe de desenvolvimento deve construir a própria massa de teste. A liberação para Produção (https://api.e-docs.es.gov.br) ocorre após alinhamento e validação com o time do E-Docs.

Integração com API Organograma

Solicite ao Analista Responsável a abertura de um atendimento para a SGITG pelo E-Flow, com o seguinte texto:

"Solicito à SGITG permissões de aplicação no sistema Organograma, a serem concedidas via Acesso Cidadão:"

• Slug do sistema no AC: [slug_do_sistema_no_acesso_cidadao]
• O sistema irá consultar informações de organizações e setores?: (Sim/Não)