Configuração do Acesso

Instruções sobre como configurar e liberar o acesso à API.

Quando um usuário administrador na respectiva base do sistema criar o seu acesso para consumo da API, deve ter em mente que duas parametrizações relacionadas à permissão e segurança devem ser feitas.

1. Criação do Perfil

Dentro do sistema Siprov todo usuário tem um perfil vinculado.

Esse perfil determina a quais recursos o respectivo usuário terá acesso.

No caso de um usuário exclusivamente criado para uso na API, dentro da tela Cadastro de Perfil existirá uma seção nomeada API na qual está listada todos os métodos (endpoints) que tal acesso poderá usar. Isso serve para restringir o acesso e uso somente a um ou outro recurso. Por exemplo, às vezes você quer liberar somente métodos relacionados à cliente ou contratos, mas não à parte financeira.

Dessa forma, mesmo ele tendo um usuário e visualizando toda a documentação, ele só conseguirá usar efetivamente métodos que foram liberados no respectivo perfil.

2. Configuração da API

Além disso, pode ser que você queira delimitar o acesso a dados específicos dentro dos métodos, ainda mais no cenário atual que as empresas devem estar muito atentas às normas da LGPD.

Então, na tela Configuração da API (dentro do Siprov acesse o menu 'Ferramentas > Complementos > API), o usuário consegue ver quais dados cada método expõe no retorno da consulta, inserção ou edição efetuada.

Assim, o usuário conseguirá marcar ou desmarcar algum campo para ser disponibilizado ou não nesse retorno.

Isso é útil em cenários em que o usuário administrador da base não quer dispor, por exemplo, de dados sensíveis da sua base, como CPF, data de nascimento, email, telefone, etc.

Dito isso, mesmo o usuário tendo acesso ao método, não quer dizer que ele acessará todos os dados que poderiam estar disponíveis.

Caso o usuário administrador tenha dúvida de como efetuar tais configurações, só entrar em contato com nossa equipe.