Autenticação

Detalhamento de como deve ser feita a autenticação na API do Siprov.

Primeiro passo para uso da API do Siprov é chamar o método Autenticação (/ext/autenticacao) para capturar sua chave de acesso.

Você deve fazer um POST neste método passando o usuário e senha recebido como autenticação do tipo Basic Auth.

Exemplo de requisição:

curl --request POST \
     --url https://acesso.siprov.com.br/siprov-api/ext/autenticacao \
     --header 'accept: text/plain' \
     --header 'authorization: Basic dGVzdGU6dGVzdGU='

Ao efetuar tal chamada, no retorno constará a chave (authorizationToken) que deverá ser usada na autenticação dos demais métodos. No caso, a autenticação então passa a ser do tipo Bearer Token.

A chave gerada tem validade de 12 horas. Logo, esse método deve ser chamado recorrentemente para renovação da chave. Ou podem efetuar tal chamada a cada uso dos demais métodos para sempre obter a chave atualizada para o momento.

Atente-se também que qualquer alteração efetuada na configuração de acesso implica obrigatoriamente na renovação da chave.

Por fim, explicamos os demais campos que constaram no retorno desse método:

  • codUsuario: Código único do usuário autenticado na API;

  • nomeUsuario: Nome do respectivo usuário;

  • codClienteSiprov: Código único da empresa responsável pela base no sistema;

  • nomeClienteSiprov: Nome da respectivo empresa;

  • permissaoLoja: Lista de unidades (ou loja), que geralmente são filiais ou regionais, liberadas nesse usuário;

    • codLoja: Código único da unidade (loja);

    • nome: Nome da unidade (loja).

  • plano: Lista de planos liberados para esse usuário:

    • codPlano: Código único do plano;

    • nome: Nome do plano.

Atualizado

Isto foi útil?