TOTVS Logística Recintos Aduaneiros

Árvore de páginas

Tempo aproximado para leitura: 2 min

CONTEÚDO

01. VISÃO GERAL

O SARA | RESTServer é um novo serviço provedor de APIs para o Sistema SARA, permitindo assim a construção de novas funcionalidades back-end, para serem consumidas por outras aplicações front-end ou por outros serviços por meio do protocolo HTTP (Web Service REST). 

02. ARQUITETURA

        


Abaixo segue um exemplo básico, com um passo-a-passo da execução de uma requisição REST:

  1. Uma aplicação cliente (Front-end), faz uma requisição REST com base em uma URL, onde é informado o método (GET, POST, PUT ou DELETE) e alguns parâmetros obrigatórios conforme documentação SWAGGER de cada API.

    Exemplo
    URL para consulta de todos os registro referente ao cadastro de unidades de medida.
    GET | http://localhost:8081/api/sara/tabelas-dominio/v1/unidades-medida

  2. Após o envio, o servidor por meio do Serviço SARA | RESTServer processa a requisição.

    Exemplo
    O arquivo APPServer.EXE recebe a requisição e efetua a autenticação segura via TOKEN JWT.
    Após a realização da autenticação, por meio da URL, valida se a ROTA existe e se o usuário da requisição tem acesso a funcionalidade.
    Com a rota validada, o serviço pesquisa qual o nome da BPL relacionada a ROTA, e efetua a execução da BPL passando os parâmetros da requisição HTTP.
    Neste exemplo, a BPL que será chamada é a UnidadeMedida.BPL.

  3. Cada arquivo BPL tem a responsabilidade de validar os parâmetros da requisição de acordo com o método (GET, POST, PUT ou DELETE). As BPL possuem as regras de negócio de cada domínio, efetuando cálculos, consulta e gravações ao Banco de Dados.

  4. Para acesso ao Banco de Dados, cada BPL de negócio executa o arquivo DATA.bpl, que é responsável exclusivamente pela conexão com o Banco de Dados e a execução dos SQLs enviados pela BPL de negócio.

  5. Após a requisição de consulta ou gravação ao Banco de Dados, a BPL de negócio devolve um RESPONSE para o serviço (APPServer.exe), contendo o status do resultado e um JSON com as informações, se for o caso.

    Abaixo segue um exemplo da execução do método GET da API referente a Unidade de Medida:

03. MANUAL DE INSTALAÇÃO

Para a instalação e configuração do serviço, acesse o documento: SARA | RESTServer - Manual Técnico de Instalação e Atualização.