rsei/README.Rmd at main · StrategicProjects/rsei · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# rsei (R + SEI) <a href="https://strategicprojects.github.io/rsei/"><img src="man/figures/logo.png" align="right" height="113" alt="rsei website" /></a>

<!-- badges: start -->
![](https://img.shields.io/badge/devel%20version-0.1.0-blue.svg)
[![R-CMD-check](https://github.com/StrategicProjects/rsei/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/StrategicProjects/rsei/actions/workflows/R-CMD-check.yaml)
[![pkgdown](https://github.com/StrategicProjects/rsei/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/StrategicProjects/rsei/actions/workflows/pkgdown.yaml)
<!-- badges: end -->

`rsei` é um toolkit em R para os Web Services SOAP do **SEI** (Sistema Eletrônico
de Informações). Ele monta os envelopes SOAP no formato esperado pelo SEI, executa
as chamadas com `httr2`, trata erros HTTP e *SOAP Fault*, e devolve os resultados
como `tibble`. Cobre consultas (`consultar_*`), listagens (`listar_*`), operações
de escrita (`gerar_procedimento`, `incluir_documento`, `enviar_processo`, ...) e
os serviços do **SIP** (`listar_permissao`, `replicar_permissao`, `replicar_usuario`).

> **⚠️ Acesso restrito por IP.** Os Web Services do SEI são protegidos por
> *firewall*: só respondem a requisições vindas de **IPs/servidores previamente
> autorizados** no cadastro do serviço no SEI. As funções deste pacote só
> retornarão dados quando executadas a partir de um host autorizado (por exemplo,
> o servidor institucional). A partir de um IP não autorizado as chamadas falham
> por *timeout* ou conexão recusada. A autenticação adicional é feita por
> `SiglaSistema` + chave de acesso (`IdentificacaoServico`).

## Arquitetura

Todas as operações são wrappers finos sobre um único motor SOAP
(`sei_build_envelope()` + `sei_call()`), com configuração centralizada
(`sei_config()`) e parsers que devolvem `tibble`.

<img src="man/figures/arquitetura.svg" width="100%" alt="Arquitetura do pacote rsei: código do usuário, funções de alto nível, núcleo SOAP e os Web Services SEI/SIP" />

O fluxo de uma chamada — da função ao `tibble`, com tratamento de erro:

<img src="man/figures/fluxo.svg" width="100%" alt="Fluxo de uma chamada: função, envelope, POST httr2, Web Service, tratamento de SOAP Fault e parse para tibble" />

## Instalação

```r
# install.packages("remotes")
remotes::install_github("StrategicProjects/rsei")
```

## Configuração

```r
library(rsei)

# Configuração reutilizada por todas as funções
# Funciona com qualquer instalação do SEI: aponte `sei_url` para o
# endpoint do Web Service do seu servidor.
cfg <- sei_config(
  sei_url               = "https://sei.<seu-orgao>.gov.br/sei/ws/SeiWS.php",
  sigla_sistema         = "MEU_SISTEMA",
  identificacao_servico = Sys.getenv("RSEI_IDENTIFICACAO_SERVICO")  # chave de acesso
)

# Opcional: definir como padrão da sessão (dispensa passar `config`)
sei_set_default_config(
  sei_url               = "https://sei.<seu-orgao>.gov.br/sei/ws/SeiWS.php",
  sigla_sistema         = "MEU_SISTEMA",
  identificacao_servico = Sys.getenv("RSEI_IDENTIFICACAO_SERVICO")
)
```

## Exemplo

```r
# Consultar um processo (retorna um tibble)
proc <- consultar_procedimento("0000000000.000001/2020-11", config = cfg)
proc$Especificacao
proc$Assuntos[[1]]          # coluna-lista com os assuntos

# Listar unidades, séries, tipos de processo, ...
unidades <- listar_unidades(cfg)
series   <- listar_series(cfg)
```

As operações de **escrita** alteram dados no SEI e devem ser validadas em
ambiente de homologação/treino antes de uso em produção.

---

`rsei` faz parte de um ecossistema de pacotes R desenvolvido na
[Secretaria Executiva de Monitoramento Estratégico](https://monitoramento.sepe.pe.gov.br).
```