Referência da API¶
Cliente SEI¶
seigov.client.SeiClient ¶
Cliente dos Web Services do SEI.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
config
|
Optional[SeiConfig]
|
Um :class: |
None
|
call ¶
call(operation, *, inject_auth=True, **params)
Chama uma operação SOAP do SEI e devolve o objeto zeep (cru).
Injeta SiglaSistema/IdentificacaoServico por padrão. Traduz
SOAP Fault e erros de transporte em :class:SeiFault/:class:SeiError.
Qualquer operação do WSDL pode ser chamada por aqui.
consultar_procedimento ¶
consultar_procedimento(protocolo_procedimento, *, id_unidade=None, retornar_assuntos=True, retornar_interessados=True, retornar_observacoes=True, retornar_andamento_geracao=True, retornar_andamento_conclusao=True, retornar_ultimo_andamento=True, retornar_unidades_procedimento_aberto=True, retornar_procedimentos_relacionados=True, retornar_procedimentos_anexados=True, raw=False)
Consulta um processo (consultarProcedimento).
consultar_documento ¶
consultar_documento(protocolo_documento, *, id_unidade=None, retornar_andamento_geracao=True, retornar_assinaturas=True, retornar_publicacao=True, retornar_campos=True, raw=False)
Consulta um documento (consultarDocumento).
consultar_publicacao ¶
consultar_publicacao(*, id_publicacao='', id_documento='', protocolo_documento='', id_unidade=None, retornar_andamento=True, retornar_assinaturas=True, raw=False)
Consulta uma publicação (consultarPublicacao). Informe um de
id_publicacao/id_documento/protocolo_documento.
consultar_bloco ¶
consultar_bloco(id_bloco, *, id_unidade=None, retornar_protocolos=False, raw=False)
Consulta um bloco (consultarBloco).
consultar_procedimento_individual ¶
consultar_procedimento_individual(*, id_orgao_procedimento, id_tipo_procedimento, id_orgao_usuario, sigla_usuario, id_unidade=None, raw=False)
Consulta o processo individual mais recente (consultarProcedimentoIndividual).
listar_unidades ¶
listar_unidades(*, id_tipo_procedimento='', id_serie='', raw=False)
Lista unidades acessíveis ao serviço (listarUnidades).
listar_series ¶
listar_series(*, id_unidade='', id_tipo_procedimento='', raw=False)
Lista tipos de documento/séries (listarSeries).
listar_tipos_procedimento ¶
listar_tipos_procedimento(*, id_unidade='', id_serie='', raw=False)
Lista tipos de processo (listarTiposProcedimento).
listar_tipos_procedimento_ouvidoria ¶
listar_tipos_procedimento_ouvidoria(*, raw=False)
Lista tipos de processo de Ouvidoria (listarTiposProcedimentoOuvidoria).
listar_usuarios ¶
listar_usuarios(*, id_unidade=None, id_usuario='', raw=False)
Lista usuários da unidade (listarUsuarios).
listar_hipoteses_legais ¶
listar_hipoteses_legais(*, id_unidade=None, nivel_acesso='', raw=False)
Lista hipóteses legais (listarHipotesesLegais).
listar_estados ¶
listar_estados(*, id_unidade=None, id_pais='', raw=False)
Lista estados/UF (listarEstados).
listar_cidades ¶
listar_cidades(*, id_unidade=None, id_pais='', id_estado='', raw=False)
Lista cidades (listarCidades).
listar_cargos ¶
listar_cargos(*, id_unidade=None, id_cargo='', raw=False)
Lista cargos (listarCargos).
listar_contatos ¶
listar_contatos(*, id_unidade=None, id_tipo_contato='', pagina_registros='', pagina_atual='', sigla='', nome='', cpf='', cnpj='', matricula='', raw=False)
Lista contatos (paginado) (listarContatos).
listar_feriados ¶
listar_feriados(*, id_unidade=None, id_orgao='', data_inicial='', data_final='', raw=False)
Lista feriados (listarFeriados).
listar_extensoes_permitidas ¶
listar_extensoes_permitidas(*, id_unidade=None, id_arquivo_extensao='', raw=False)
Lista extensões de arquivo permitidas (listarExtensoesPermitidas).
listar_marcadores_unidade ¶
listar_marcadores_unidade(*, id_unidade=None, raw=False)
Lista marcadores da unidade (listarMarcadoresUnidade).
listar_tipos_conferencia ¶
listar_tipos_conferencia(*, id_unidade='', raw=False)
Lista tipos de conferência (listarTiposConferencia).
listar_andamentos ¶
listar_andamentos(protocolo_procedimento, *, id_unidade=None, retornar_atributos=False, andamentos=None, tarefas=None, tarefas_modulos=None, raw=False)
Lista andamentos de um processo (listarAndamentos). Exige ao menos
um de andamentos/tarefas/tarefas_modulos.
listar_andamentos_marcadores ¶
listar_andamentos_marcadores(protocolo_procedimento, *, id_unidade=None, marcadores=None, raw=False)
Lista andamentos de marcadores (listarAndamentosMarcadores).
gerar_procedimento ¶
gerar_procedimento(procedimento, *, id_unidade=None, documentos=None, procedimentos_relacionados=None, unidades_envio=None, manter_aberto_unidade=True, enviar_email_notificacao=False, raw=False, **extra)
Gera um novo processo (gerarProcedimento). ALTERA dados.
incluir_documento ¶
incluir_documento(documento, *, id_unidade=None, raw=False)
Inclui um documento (incluirDocumento). ALTERA dados.
lancar_andamento ¶
lancar_andamento(protocolo_procedimento, *, id_unidade=None, id_tarefa=None, id_tarefa_modulo=None, atributos=None, raw=False)
Lança um andamento (lancarAndamento). ALTERA dados.
enviar_processo ¶
enviar_processo(protocolo_procedimento, unidades_destino, *, id_unidade=None, manter_aberto_unidade=False, remover_anotacao=False, enviar_email_notificacao=False, reabrir=False)
Envia (tramita) um processo (enviarProcesso). Retorna o resultado.
atribuir_processo ¶
atribuir_processo(protocolo_procedimento, id_usuario, *, id_unidade=None, reabrir=False)
Atribui um processo a um usuário (atribuirProcesso).
concluir_processo ¶
concluir_processo(protocolo_procedimento, *, id_unidade=None)
Conclui um processo na unidade (concluirProcesso).
reabrir_processo ¶
reabrir_processo(protocolo_procedimento, *, id_unidade=None)
Reabre um processo (reabrirProcesso).
bloquear_processo ¶
bloquear_processo(protocolo_procedimento, *, id_unidade=None)
Bloqueia um processo (bloquearProcesso).
desbloquear_processo ¶
desbloquear_processo(protocolo_procedimento, *, id_unidade=None)
Desbloqueia um processo (desbloquearProcesso).
excluir_processo ¶
excluir_processo(protocolo_procedimento, *, id_unidade=None)
Exclui um processo (excluirProcesso). Irreversível.
cancelar_documento ¶
cancelar_documento(protocolo_documento, motivo, *, id_unidade=None)
Cancela um documento (cancelarDocumento).
excluir_documento ¶
excluir_documento(protocolo_documento, *, id_unidade=None)
Exclui um documento (excluirDocumento).
enviar_email ¶
enviar_email(protocolo_procedimento, de, para, assunto, mensagem, *, id_unidade=None, cco=None, id_documentos=None, raw=False)
Envia e-mail vinculado a um processo (enviarEmail).
atualizar_contatos ¶
atualizar_contatos(contatos, *, id_unidade=None)
Atualiza contatos (atualizarContatos).
gerar_bloco ¶
gerar_bloco(tipo, descricao, *, id_unidade=None, unidades_disponibilizacao=None, documentos=None, disponibilizar=False)
Gera um bloco (gerarBloco). Retorna o número do bloco.
incluir_documento_bloco ¶
incluir_documento_bloco(id_bloco, protocolo_documento, *, id_unidade=None, anotacao='')
Inclui documento em bloco (incluirDocumentoBloco).
incluir_processo_bloco ¶
incluir_processo_bloco(id_bloco, protocolo_procedimento, *, id_unidade=None, anotacao='')
Inclui processo em bloco (incluirProcessoBloco).
disponibilizar_bloco ¶
disponibilizar_bloco(id_bloco, *, id_unidade=None)
Disponibiliza um bloco (disponibilizarBloco).
consultar_procedimentos ¶
consultar_procedimentos(protocolos, *, parar_em_erro=False, **kwargs)
Consulta vários processos e empilha (colunas protocolo e erro).
consultar_documentos ¶
consultar_documentos(protocolos, *, parar_em_erro=False, **kwargs)
Consulta vários documentos e empilha (colunas protocolo e erro).
consultar_publicacoes ¶
consultar_publicacoes(ids, *, por='id_documento', parar_em_erro=False, **kwargs)
Consulta várias publicações e empilha. por =
id_documento/protocolo_documento/id_publicacao.
listar_andamentos_completo ¶
listar_andamentos_completo(protocolo_procedimento, *, id_unidade=None, tarefas=range(1, 201), retornar_atributos=False, ordenar=True)
Linha do tempo completa de andamentos, ordenada por data/hora.
Como listarAndamentos exige filtro, usa um intervalo amplo de tarefas.
listar_documentos_processo ¶
listar_documentos_processo(protocolo_procedimento, *, id_unidade=None, consultar=False)
Documentos de um processo, reconstruídos a partir dos andamentos.
O WS não lista documentos diretamente; extrai os números das descrições (ex.: "Gerado documento ... 84230597"). Heurística — depende do texto.
listar_publicacoes_processo ¶
listar_publicacoes_processo(protocolo_procedimento, *, id_unidade=None)
Publicações de um processo (documentos do processo que têm publicação).
Cliente SIP¶
seigov.sip.SipClient ¶
Cliente dos Web Services do SIP.
listar_permissao ¶
listar_permissao(*, id_orgao_usuario='', id_usuario='', id_origem_usuario='', id_orgao_unidade='', id_unidade='', id_origem_unidade='', id_perfil='', raw=False)
Lista permissões no SIP (listarPermissao).
replicar_permissao ¶
replicar_permissao(permissoes)
Replica (cadastra/altera/exclui) permissões (replicarPermissao).
permissoes: lista de dicts da estrutura Permissao (ao menos
StaOperacao, IdSistema, IdPerfil).
replicar_usuario ¶
replicar_usuario(usuarios, *, considerar_orgao=False)
Replica (cadastra/altera/desativa/reativa) usuários (replicarUsuario).
usuarios: lista de dicts (ao menos StaOperacao e IdOrigem).
Configuração¶
seigov.config.SeiConfig
dataclass
¶
Configuração do SEI.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
url
|
str
|
Endpoint do Web Service do SEI do seu órgão, ex.:
|
''
|
wsdl
|
str
|
Opcional. Caminho/URL de um WSDL alternativo. Se vazio, usa o WSDL do
SEI empacotado (o schema é universal) e o endpoint vem de |
''
|
sigla_sistema
|
str
|
Credenciais do serviço ( |
''
|
identificacao_servico
|
str
|
Credenciais do serviço ( |
''
|
id_unidade
|
str
|
Unidade padrão (muitas operações aceitam vazio). De |
''
|
timeout
|
int
|
Tempo máximo (s) das requisições. |
60
|
seigov.config.SipConfig
dataclass
¶
Configuração do SIP (Sistema de Permissões).
Autenticação por ChaveAcesso + IdSistema. Namespace sipns.
Utilitários¶
seigov.parse.to_dataframe ¶
to_dataframe(obj, *, sep='_')
Serializa obj e devolve um DataFrame (uma linha por registro).
seigov.exceptions.SeiError ¶
Bases: Exception
Erro genérico ao falar com o SEI/SIP (conexão, configuração, timeout).