- API Partners – Ideia e Funcionalidade
A API Partners tem por objetivo permitir que usuários (previamente configurados) externos ao Advwin+ consigam visualizar/consultar informações de pastas. Esses usuários não são convencionais, pois possuem acesso limitado, restrito apenas aos dados definidos por grupos de segurança.
OBS: nenhum usuário de API terá acesso ao ADVWin+ via aplicação.
Para o usuário de API ter acesso ao Advwin+ é preciso contratar licenças.
- Cadastros necessários
Para que o usuário de API possa consultar as informações da pasta, algumas configurações precisam ser feitas no ADVWIN+ e já possuem manuais disponibilizados pela TWT.
- Cadastro de um novo Advogado;
- Cadastro de um novo usuário;
- Vincular o usuário a um grupo de segurança;
- Nas permissões do módulo de ‘pasta’ o usuário deve conseguir ‘listar’.
OBS: é indispensável a criação de um novo usuário para API, usuários já cadastrados no sistema NÃO poderão ser usuários de API.
- Configurações
A forma que será utilizada para o sistema identificar o usuário de API é através da configuração do TOKEN:
Para acessar a tela de configuração do Token, clique em ‘Arquivos’ (01) ‘Pré-Cadastro’ (02).
II. Na tela das tabelas de Pré-Cadastro, pesquise por ‘Token’.
III. Na tela inicial ‘Token’, clique em ‘Api – Partners’
- Após selecionar ‘Api – Partners’, escreva o nome do usuário de API no espaço em destaque e clique em ‘Salvar’
- Para configurar mais de um usuário de API é necessário separar os nomes utilizando vírgulas “,”. EX: Userapi, Userapitest.
OBS: o que irá distinguir um usuário convencional de um usuário de API é a configuração do TOKEN.
- Ao tentar logar no sistema com um usuário de API, o sistema emitirá um alerta.
- POST MAN
Com as configurações do usuário de API feitas no Advwin+, abra a aplicação ‘Post man’ para que consiga consultar as informações da pasta (lembrando que apenas os campos configurados pelo grupo de segurança poderão ser visualizados.)
- Acesse a aplicação. Postman API Platform
- POST: Preencha as informações de login para efetuar a autenticação no ambiente do ADVWin+ e para obter um token de consumo para os demais endpoints.
- PUT: Deverá ser consumido sempre que o login apontar a necessidade de troca de senha. Atenção para o tempo de expiração do token retornado no login, pois pode ser necessário chamar novamente para obter um token dentro do tempo válido.
- GET: Após trocar a senha, refaça o login e adicione o número da pasta que será consultada.
- Aviso Legal
Este documento contém informações confidenciais ou privilegiadas de uso exclusivo da TWTINFO. Caso não seja o destinatário ou a pessoa autorizada a receber esse documento, não poderá usar, copiar e divulgar as informações nele contidas.