Automações com APIs
Last updated
Last updated
O primeiro passo, é obter a chave da API na tela de configurações para autenticar
Com essa chave, você já consegue autenticar as requisições à API.
Chamada para realizar uma listagem de usuários do sistema
Resposta do servidor
Aonde o array reports retorna o ID dos relatórios que o usuário tem acesso.
Você também pode filtrar a lista de usuário por nome e/ou e-mail
Para criar um novo usuário no sistema, utilize a chamada abaixo:
Onde as roles são: 1 = Administrador 2 = Contribuidor 3 = Visualizador
Para apagar um usuário do sistema, utilize a chamada abaixo:
Você também pode dar permissão para um usuário acessar um determinado relatório, informando o e-mail do usuário e uma lista com os ID’s dos relatórios:
Para remover a permissão de um usuário em um relatório, utilize a chamada abaixo:
Você também pode listar os relatórios existentes para recuperar alguns metadados, como o ID do relatório:
Também é possível filtrar o relatório pelo nome, workspace ou tipo:
Você também pode listar o nome das roles que um relatório possui, para criar a associação Relatório X Usuário X Role (RLS), onde o parâmetro da chamada é o ID do relatório:
Para listar esse mapeamento entre Relatório x Usuário x Role, você pode utilizar a chamada abaixo, e poderá filtrar os dados pelo ID do usuário, Id do relatório ou nome da role:
Para atribuir uma permissão de RLS, você irá passar uma lista de e-mails que vão ser adicionados na regra do RLS, o ID do relatório e o nome da role que os usuários serão adicionados:
Para remover a permissão RLS, você vai mudar somente a URL da requisição, pois são os mesmos parâmetros para adicionar
Você também pode utilizar a API para acessar o log de auditoria de relatórios e conseguir consultar todos os acessos a relatórios realizados pelos usuários do Power Embedded.
Você pode aplicar filtros na requisição por vários campos
Para saber mais sobre exibição de relatórios em aplicações externas, acesse a página Mostrar relatórios no seu sistema.
Documentação completa da API: Swagger UI (powerembedded.com.br)
Página de demonstração da API para Embeddar os relatórios: Demo – PowerPortal.IntegrationDemo (powerembedded.com.br)
