Pular para o conteúdo principal

Integração com sistemas

A integração com o PermissãoES permite que sistemas governamentais consultem permissões e escopos sem manter regras locais duplicadas de autorização.

Pré-requisitos​

Antes da integração, o sistema deve possuir:

  • cadastro na Árvore de Serviços;
  • responsáveis administrativos definidos;
  • equipe técnica responsável;
  • modelo de perfis definido;
  • gestores de permissão total indicados;
  • estratégia de autenticação com Acesso Cidadão, quando houver usuário final autenticado;
  • autorização para consumo da API PermissãoES.

Fluxo técnico conceitual​

Responsabilidade do sistema integrado​

O sistema integrado deve:

  • autenticar corretamente o usuário;
  • consultar a API quando precisar avaliar autorização;
  • aplicar suas regras de negócio com base nos perfis e escopos retornados;
  • evitar replicação desnecessária de permissões;
  • registrar logs próprios de uso quando necessário;
  • tratar ausência de permissão de forma clara para o usuário.

Responsabilidade do PermissãoES​

O PermissãoES fornece:

  • grupos de permissão;
  • perfis concedidos;
  • escopos organizacionais;
  • auditoria de concessões;
  • resolução de permissões conforme o modelo configurado;
  • API estruturante para consumo dos sistemas autorizados.

Padrão de retorno conceitual​

A API retorna permissões em formato adequado ao sistema consumidor, contendo, de forma conceitual:

{
  "sistema": "sistema-exemplo",
  "cidadaoId": "00000000-0000-0000-0000-000000000000",
  "perfis": [
    {
      "nome": "Gestor de Unidade",
      "escopos": [
        {
          "tipo": "Unidade",
          "identificador": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  ]
}
info

O contrato técnico detalhado deve ser consultado na documentação OpenAPI da API PermissãoES, conforme autorização da equipe responsável pela integração.