API TI9 - WebService - Manual de Utilização 2.0

VERSIONAMENTO:

Versão	Editor	Resumo	Data
1.0	Rogerio Rezende	Versão Java e Tomcat	15/05/2020
1.1	Gabriel Angeli	Senha e Active Directory	11/06/2020
2.0	Rogerio Rezende	Java 11 e Tomcat Embarcado	20/10/2021

ESPECIFICAÇÕES

Disponibilizamos abaixo as especificações técnicas para utilização desta API. As chamadas da API (WebService) são síncronas - a cada chamada o serviço irá responder com sucesso ou falha, juntamente com a mensagem de retorno.

Pré-requisitos

O serviço será iniciado pelo Apache Tomcat Embarcado no arquivo ".JAR" da API, sendo executado em porta aleatória;
O servidor deve ter a instalação do Java 11 (JRE);
Uso de um certificado SSL (HTTPS) para garantir a segurança da troca de informação entre os sistemas.

Autenticação

A API requer autenticação com um usuário previamente cadastrado no ERP Ti9 e sua respectiva senha criptografada armazenada no banco de dados. A autenticação retorna uma chave codificada (token JWT com expiração em 1 hora, do tipo "Bearer") que será criada e administrada pela Ti9.

A criação do usuário e senha, bem como a atualização da senha periodicamente, devem ser realizadas pela empresa em conjunto com os mantenedores de outras aplicações que utilizem estes dados, visto que os mesmos serão atualizados também na aplicação deles.

A criação e a manutenção do usuário devem ser feitas por meio do "Launcher do Ti9 > Central de Segurança > Usuários", como qualquer outro usuário. Porém, não é necessário configurar nenhuma permissão específica ao usuário, deve-se apenas cadastrá-lo com sua senha.

Os softwares devem utilizar o nome informado no campo "Login" e o código MD5 da senha atribuída ao mesmo para a autenticação com a API do Ti9.

IMPORTANTE

O padrão adotado pelo TI9 é de armazenar na base de dados a senha de forma maiúscula quando não se utiliza os recursos do Microsoft Active Directory. Portanto, nestes casos, para se gerar o hash md5 da senha, deve-se gerá-lo com os caracteres maiúsculos da senha.

Para os casos onde o Active Directory está ativado, deve ser enviado no “request body” o hash md5 gerado considerando os caracteres da senha assim como eles são.

Exemplo de Utilização:

https://ip:porta/ti9-api/v4/auth

Request Body:

{

"login": "LOGIN",

"senha": "MD5-DA-SENHA"

}

Response:
{

"token": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJmcC1hcGkiLCJzdWIiOi...QUxITyJ9.tmI-RuyCvb...",

"type": "Bearer"

}