TOTVS AGRO

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

Versões comparadas

Versão antiga 7

changes.mady.by.user Jose Alberto da Silva

Gravado em

comparado com

Nova versão 8

changes.mady.by.user Jose Alberto da Silva

Gravado em

Chave

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

Nesta página, é descrita a arquitetura de componentes e tecnologia utilizadas pelo TOTVS Agro API Hub, como forma de apresentar e elucidar a estrutura unificada e padronizada desenvolvida para expor as APIs do ecossistema TOTVS Agro Bioenergia. Este hub atua como uma camada de abstração e governança técnica centralizada, fornecendo endpoints RESTful consistentes, documentação interativa via Swagger/OpenAPI, gestão de ciclos de vida (API Lifecycle) e mecanismos robustos de segurança e autenticação (como OAuth 2.0). Seu propósito fundamental é simplificar e escalar a integração entre os sistemas corporativos (como ERPs, plataformas de trading, aplicações de campo e ferramentas de análise) e a suite de soluções TOTVS para o agronegócio, promovendo interoperabilidade, reduzindo a complexidade no desenvolvimento e acelerando a inovação digital no setor de bioenergia.

Links e referências

TOTVS Developers
https://api.totvs.com.br/

TOTVS API Pocket
https://api.totvs.com.br/guia

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


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;




Consumo das APIs

O API HUB possui dois modelos de URL entidades e queries cadastradas é composta conforme conforme configurado no cadastro da EntityAPI e QueryHe/QueryDe, para os campos apiVersion e pathUrl, conforme demonstrado a seguir:

    • Entidade: http://IP :PORTA/api/entity/[apiVersion]/[pathUrl]
    • Query: http://IP :PORTA/api/query/[apiVersion]/[pathUrl]

Os métodos HTTPs que podem ser utilizados são GET, POST, PUT, DELETE e PATCH (modelo entity), e estarão disponíveis conforme configurados em cada modelo de exposição de APIs.

Lista de 


...

Requisitos

Requisitos de Hardware

  • Recomendado (Equivalente ou superior): CPU Intel® Xeon® Gold 5415+ Processor (22.5M Cache, 2.90 GHz) / 4 vCPU
  • Recomendado (inicial): 12 GB de RAM disponível (somente para TOTVS Agro API Hub + PostgreSQL);

  • Recomendado: 30 GB espaço em disco disponível (somente para TOTVS Agro API Hub + PostgreSQL);


...

  • 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

Composição da URL da API

A URL para as entidades e queries cadastradas é composta conforme conforme configurado no cadastro da EntityAPI e QueryHe/QueryDe, para os campos apiVersion e pathUrl, conforme demonstrado a seguir:

  • Entidade: http://IP :PORTA/api/entity/[apiVersion]/[pathUrl]
  • Query: http://IP :PORTA/api/query/[apiVersion]/[pathUrl]

...