Sobre a API eProtocolo (spi-servicos)


O eProtocolo é o sistema de tramitação interno do Poder Executivo do Estado do Paraná, regulamentado pelo Decreto Estadual nº 7304/2021, tendo como objetivo unificar e dar maior agilidade e segurança às atividades de protocolo e
organização de arquivos do Estado, para controlar os documentos emitidos e recebidos no âmbito dos órgãos e entidades do Governo do Estado.

A presente documentação tem a finalidade de orientar o desenvolvedor no processo de integração dos diversos sistemas do Estado com o eProtocolo.

A API do eProtocolo foi desenvolvida baseando-se em tecnologias que visam padronizar a documentação, a gestão dos recursos e principalmente o acesso e segurança das informações requisitadas.


Quais as URLs para consumir os serviços do eProtocolo?

     desenv -> https://homologacao.apigateway.celepar.parana/seap/spi-servicos/api-des
     homolog -> https://homologacao.apigateway.celepar.parana/seap/spi-servicos/api-hml  e  https://homologacao.apigateway.pr.gov.br/seap/spi-servicos/api-hml 1
     treinamento -> https://homologacao.apigateway.celepar.parana/seap/spi-servicos/api-tre  e  https://homologacao.apigateway.pr.gov.br/seap/spi-servicos/api-tre 1
     prod -> https://apigateway.celepar.parana/seap/spi-servicos/api  e  https://apigateway.pr.gov.br/seap/spi-servicos/api 1

     1 O acesso ao API Gateway deve ocorrer de acordo com a origem. Se a origem da chamada (servidor) estiver na intranet, deve entrar pela rota intranet (celepar.parana).
       Se a origem da chamada (servidor) estiver na Internet, deve entrar pela rota Internet (pr.gov.br).



Como é composta a URL no webservice do eProtocolo?

     A URL para consumir os serviços do eProtocolo (spi-servicos) tem a seguinte composição:

     https://homologacao.apigateway.pr.gov.br/spi-servicos/api/v3/protocolos/{protocolo}

     • Protocol
     • Host (Domain name)
     • Application context
     • Application path
     • Version
     • Resource
     • Parameter

Como obter as credenciais para integrar com o webservice do eProtocolo (spi-servicos)?


Central de Segurança

Para garantir a segurança das informações requisitadas, todos os serviços do eProtocolo disponíveis necessitam de autenticação e autorização.
Neste sentido, o eProtocolo utiliza a solução Central de Segurança para gerar um token JWT (JSON Web Token) que será utilizado para consumir os serviços.

Para gerar o token no formato JWT, é necessário o cadastro do sistema no Sentinela/Central de Segurança.
Mesmo que o sistema - que irá se integrar ao eProtocolo - não possua sua autenticação (login do usuário) via Central de Segurança, é possível fazer a integração via token do tipo client_credentials.

Neste caso, a equipe de desenvolvimento do eProtocolo irá realizar o cadastro do sistema no Sentinela, apenas para proporcionar a integração com o spi-servicos.

Caso o sistema que irá se integrar com o spi-servicos já possua sua autenticação (login do usuário) via Central de Segurança, é possível fazer a integração via token do tipo authorization_code.
Neste caso é possível utilizar o token do usuário logado no sistema integrado para consumir os serviços do eProtocolo, desde que sejam incluídos os escopos necessários.

O cadastro no Central de Segurança irá gerar um clientId e um secretId para cada ambiente.


Quais são as URLs da Central de Segurança para obter o token client_credentials?

     desenv -> http://auth-cs.desenvolvimento.celepar.parana/centralautenticacao/api/v1/token/jwt
     homolog -> https://auth-cs-hml.identidadedigital.pr.gov.br/centralautenticacao/api/v1/token/jwt
     treinamento -> https://auth-cs-hml.identidadedigital.pr.gov.br/centralautenticacao/api/v1/token/jwt
     prod -> https://auth-cs.identidadedigital.pr.gov.br/centralautenticacao/api/v1/token/jwt


API Gateway

Além do cadastro no Sentinela/Central de Segurança, o webservice do eProtocolo utiliza o API Gateway como uma camada intermediária entre o sistema que irá se integrar e o spi-servicos.
O API Gateway é responsável por rotear as chamadas, realizar o controle de rajadas de requisições, bilhetagem, etc.

Para que o sistema seja identificado pelo API Gateway, é necessária a criação de um consumerId.
Caso o sistema que irá se integrar ao spi-servicos, ainda não possua cadastro, a equipe de desenvolvimento do eProtocolo irá realizar o cadastro do sistema no API Gateway.


Cadastro de Usuário

Internamente no eProtocolo, todas as ações executadas, como criação e tramitação de protocolos, inclusão de documentos, criação de pendências, e outras, ocorrem a partir do CPF de usuário logado.

No caso de integração sistema a sistema nem sempre é possível obter e garantir a informação de qual usuário está realizando a ação.
Desta forma é criado um usuário com o nome do sistema integrado, e com um CPF "de sistema", somente para integração.

Caso seja possível identificar o usuário logado no sistema integrado (através da Central de Segurança), o eProtocolo poderá reconhecer o CPF do usuário, situação em que as ações ocorrerão a partir de um usuário real e não um usuário de sistema.

Existem serviços que necessitam que o usuário esteja vinculado a um determinado local e/ou órgão. Independentemente do tipo do usuário, essa permissão deve ser concedida.

Nos ambientes de testes (desenvolvimento, homologação e treinamento), a vinculação deste usuário aos locais pode ser realizado pela equipe de desenvolvimento.

Porém, a concessão de permissão (vinculação de locais a usuários) em produção é de responsabilidade exclusiva do Gerenciador de Acesso do Órgão. A lista de Gerenciadores de Acesso e suas informações de contato podem ser consultadas em:
https://www.administracao.pr.gov.br/eProtocolo (Gerenciadores de Acesso - Atendimento para servidores)


Endereços IPs dos Equipamentos

Por segurança, o sistema autorizado a consumir os serviços do eProtocolo, também deve fazê-lo a partir de equipamentos previamente autorizados.
Desta forma, é necessária a liberação de IP das máquinas que irão consumir os serviços do eProtocolo.

Obs.: Para os ambientes de testes (desenvolvimento, homologação e treinamento), o acesso via VPN está liberado. Para o ambiente de produção, é liberado somente o acesso ao IP de servidores de produção.


Solicitar a criação/cadastro das credenciais

A solicitação para a criação/cadastro das credenciais do sistema deve ocorrer via PDS Mantis no projeto e-Protocolo - Integrações, da seguinte forma :

     Solicito a criação/cadastro de credenciais para nova integração com o eProtocolo (spi-servicos), de acordo com as informações abaixo:

     1) Quais as informações de cadastro do sistema?

          Sigla Sistema:
          Nome Sistema:
          Cliente:
          Descrição Sistema:
          Contato (nome/e-mail) na Celepar:
          Contato (nome/e-mail) no terceiro (caso exista):

     2) O sistema irá utilizar o login pela Central de Segurança (formato JWT)? Já possui cadastro no Sentinela/Central de Segurança?

     3) Caso a resposta da pergunta anterior seja afirmativa, qual a sigla do sistema no Sentinela e os clientId's de cada ambiente? (somente o clientId, não enviar o secretId)

          Sigla Sistema (Sentinela):
          Desenvolvimento (clientId):
          Homologação (clientId):
          Produção (clientId):

     4) O sistema possui cadastro no API Gateway? Qual o consumerId?

     5) O sistema possui cadastro no GOP? Qual o link do sistema?

     6) Quais os IPs das estações e dos servidores que irão consumir os serviços?

          Desenvolvimento (IP de estações e IP do servidor de desenvolvimento)?
          Homologação (IP de estações e IP do servidor de homologação)?
          Treinamento (IP de estações e IP do servidor de treinamento)?
          Produção (IP do servidor de produção)?

     7) Quais os escopos devem ser liberados para o sistema?