Páginas filhas
  • Arquitetura e Tecnologia - TOTVS Agro API Hub

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Painel
titleSerá Removido
  • Elaborar um diagrama arquitetural que demonstre, de forma facilitada, o API Hub e sua relação com outros elementos (banco de dados Bioenergia Oracle, banco de dados API Hub PostgreSQL, setas/linhas com relação entre componentes na arquitetura, comunicação externa (se houver), uso do WSW e o máximo de detalhes para explicar em uma ou mais imagens, o papel de API Hub e seus usos;
  • Utilizar de Excalidraw ou Miro ou PPT;
  • Avaliar o que pode ser aproveitado de ideia de outras docs neste sentido: 

    Instalação TOTVS Agro Connector Client - TOTVS AGRO - TDN
    https://tdn.totvs.com/pages/viewpage.action?pageId=570365032

    TOTVS Agro Connector - TOTVS AGRO - TDN
    https://tdn.totvs.com/display/PA/TOTVS+Agro+Connector

Segurança / Autenticação

A autenticação/autorização das APIs de integração utiliza OAuth 2.0 Client Credentials Grant, sendo o método mais utilizado e também um fluxo de autorização projetado especificamente para integrações entre sistemas backend.

Principais vantagens:

      • As credenciais do cliente são mantidas seguras e o token de acesso é temporário e pode ser revogado.
      • Suporta múltiplos clientes e permite o controle granular de permissões e acessos.
      • Amplamente adotado e suportado por muitos provedores de serviços, garantindo interoperabilidade entre sistemas diferentes.

Fluxo:

      • Cliente realiza requisição para o servidor de autorização com as credenciais Client Id e Client Secret;
      • Servidor verifica as credenciais, estando válidas retorno um token de acesso;
      • Cliente utiliza o token de acesso para autenticar as requisições feitas para o servidor de recursos

Consumo das APIs

O TOTVS Agro API - Hub disponibiliza dois modelos de URL para acesso às APIs: Entidade e Query. Cada modelo possui características específicas e métodos GET, POST, PUT, DELETE e PATCH, conforme configurado para cada API. As definições e a estrutura de cada API estão disponíveis para consulta na página APIs Padrões TOTVS Agro Bioenergia


O TOTVS Agro API - Hub disponibiliza dois modelos de URL para acesso às APIs: Entidade e Query. Cada modelo possui características específicas e suporta métodos HTTP ou HTTPs como GET, POST, PUT, DELETE e PATCH, conforme configurado para cada API.

...

As definições detalhadas e a estrutura de cada API podem ser consultadas na página APIs Padrões TOTVS Agro Bioenergia.

Segurança / Autenticação

A autenticação/autorização das APIs de integração utiliza OAuth 2.0 Client Credentials Grant, sendo o método mais utilizado e também um fluxo de autorização projetado especificamente para integrações entre sistemas backend.

Principais vantagens:

...

.

...

Fluxo:

...

...




Painel
titleSerá Removido

Características Técnicas

  • Requisitos 
  • Descrever ou tabular informações técnicas a respeito do TOTVS Agro API Hub como SO homologado, BD homologado, principais acessos que devem ser preparados para permitir a instalação, configuração e uso, URLs que devem ser liberados (e.g., TOTVS Apps e outros), autenticação, paginação, filtros, link para lista de APIs existentes;
  • Resumir (listar) e deixar claro os principais tópicos e informações que envolvem características técnicas, como forma de facilitar o primeiro entendimento sobre API Hub e suas dependências;
  • Utilizar de tópicos resumidos e objetivos, para facilitar;

...

Requisitos de Acesso Externo

O TOTVS Agro API - Hub requer acesso à internet para realizar integrações e atualizações automáticas. Para garantir seu funcionamento, é necessário possua conectividade com as URLs listadas abaixo;

...

https://tdn.totvs.com/display/INT/Guia+de+implementacao+das+APIs+TOTVS

  • TOTVS Agro API Hub (Instalação - Windows)

https://tdn.totvs.com/pages/viewpage.action?pageId=969134928

...