Integração com a API

Sou de uma empresa, escritório ou projeto externo. Posso cadastrar um sistema para usar a API do E-Docs?

Somente por meio de um órgão da Administração Pública Estadual. Toda aplicação integrada precisa de um órgão titular, que guarda as credenciais, mantém os escopos e recebe os avisos sobre a API; não existe cadastro sem órgão responsável. Combine a integração com o órgão que receberá as demandas, para que ele abra as solicitações. Não há previsão normativa para credenciar o sistema de uma pessoa jurídica de direito privado, e propostas de mudança nesse sentido devem ser levadas à GPP/SEGER.

As orientações completas estão em Quem pode solicitar.

Preciso acompanhar processos em que meu cliente é parte. Preciso integrar um sistema à API?

Não. Os Favoritos do E-Docs permitem acompanhar processos e encaminhamentos de interesse e receber notificação a cada andamento, sem ser interessado no processo: basta estar autenticado no Acesso Cidadão. Para poucos processos, é o caminho direto e dispensa desenvolvimento. Ver ou copiar os documentos continua sujeito às regras de restrição de acesso e ao credenciamento. A API não é concedida ao sistema de uma pessoa jurídica de direito privado sem órgão responsável.

As regras completas estão em Favoritos.

O que preciso fazer para meu sistema usar a API do E-Docs?

São duas solicitações, nesta ordem: o cadastro do sistema no Acesso Cidadão, que gera o identificador (slug) e as credenciais, e depois a liberação dos escopos da API do E-Docs, informando o slug e as operações do sistema (consultar, capturar, encaminhar ou praticar atos processuais). Desenvolva na versão V2 e teste no ambiente de Treinamento, que não tem dados reais; a liberação para Produção vem depois da validação pela equipe do E-Docs. Dúvidas técnicas seguem pela área de TI do seu órgão.

As orientações completas estão em Solicitação de Acesso.

Meu robô ou sistema de IA consegue ler o conteúdo dos documentos de um processo pela API?

Consegue somente sob a identidade de um usuário autenticado, e só do que esse usuário já poderia ler no E-Docs, respeitando os níveis de restrição de acesso. Sem usuário, a API entrega apenas dados públicos e metadados. Não existe credencial que leia o acervo inteiro de um órgão: o servidor aciona o sistema em cada processo que está analisando, e o órgão responsável define quem pode usá-lo.

As orientações completas estão em O que cada fluxo enxerga.

Meu sistema pode capturar ou anexar documentos em nome próprio?

Não. Captura, assinatura, encaminhamento e entranhamento têm autoria e exigem um usuário autenticado pelo Acesso Cidadão; o ato fica registrado em nome dele. Um relatório gerado por um sistema pode ser anexado a um processo, desde que a captura e o entranhamento sejam feitos por esse usuário. O acesso sem usuário não captura documentos.

As orientações completas estão em Autoria e titularidade do token.

É possível assinar documentos pela API sem que o usuário precise entrar no E-Docs?

Sim. Com um único assinante, a captura e a assinatura ocorrem no mesmo ato. Com vários, cada um assina pela API com o próprio token, e o documento só é capturado na última assinatura. Em ambos os casos, a assinatura é do titular do token e o papel informado deve ser dele. O usuário não precisa abrir o E-Docs, mas continua sendo ele quem assina: o próprio signatário, logado pelo Acesso Cidadão no sistema, aciona a assinatura. O sistema não pode assinar por ele, nem em nome de terceiro.

As orientações completas estão em Assinar sem acessar o E-Docs.

O token de usuário da API expirou depois de 1 hora. Como renovo sem pedir o login de novo?

Não é possível. O token de usuário vale 1 hora, por requisito da solução de assinatura eletrônica, e só é renovado por nova autenticação. O escopo offline_access não é concedido nas integrações com o E-Docs, e a expiração é esperada. Trate o erro 401 redirecionando o usuário ao endpoint de autorização do Acesso Cidadão. No acesso sem usuário, basta solicitar um novo token.

As orientações completas estão em Renovação e Validade.

Posso ligar o Power BI diretamente ao E-Docs?

Não. O E-Docs não dá acesso direto à sua base a ferramentas de BI, porque ela é compartilhada por todo o Estado e por municípios, com documentos que podem ser sigilosos. A saída é a API: um sistema credenciado consulta processos pelo número de protocolo (situação, data de autuação e localização atual) e alimenta o painel. Quem não é da área técnica deve levar a demanda à TI do seu órgão.

As orientações completas estão em O que a API não oferece.

Existe relatório com a lista dos processos e encaminhamentos do meu setor?

Não existe relatório nesse formato, com número do E-Docs, data de recebimento, tema e responsável. Se a melhoria servir a todos os usuários, envie a sugestão pelo ponto focal do seu órgão. Para uma necessidade mais específica, a TI do seu órgão pode montar as consultas desejadas pela API.

As orientações completas estão em O que a API não oferece.

Meu sistema gera registros que devem ter um processo no E-Docs, como autos de infração. Como garantir que nenhum fique sem processo?

Faça o próprio sistema autuar o processo pela API no momento em que o registro (o auto de infração, por exemplo) é criado, com o escopo de atos processuais. Assim a geração do processo é garantida e não é preciso monitorar depois quais registros ficaram sem ele. Para conferir registros já existentes, consulte o processo pelo número de protocolo, que informa a situação e a localização atual. Leve a proposta à TI do seu órgão.

As orientações completas estão em Garantir um processo para cada registro do sistema.