Histórico da Página

...

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

• • Entidade

...

• • - Utilizado para operações diretas sobre entidades do sistema

...

Estrutura base de acesso :  

http://IP:PORTA/api/entity/[apiVersion]/[pathUrl]  

Exemplo 

exemplo

http:127.0.0.1:8080/api/entity/v1/unidadesMedida?page=1&pagesize=20

Exemplo de uma Entidade :  http:127.0.0.1:8080/api/query/v1/baixaConsumiveisMativ?page=1&pagesize=2

O API-Hub oferece dois modelos de URL que podem ser utilizados. A seguir, apresentamos cada um deles com suas respectivas características e aplicações.

...

• • Query - Destinado a consultas e à obtenção de dados específicos previamente definidos pela equipe de produto. 

Estrutura base de acesso :  http://IP :PORTA/api/

...

query/[apiVersion]/[pathUrl]

...

Exemplo de uma Entidade

...

:  http:

...

127.0.0.1:8080/api/query/

...

v1/baixaConsumiveisMativ?page=1&pagesize=2

...

Os métodos HTTP 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.

As definições e a estrutura de cada API estão disponíveis para consulta na página

APIs Padrões TOTVS Agro Bioenergia

Segurança / Autenticação

A autenticação/autorização das APIs de integração utilizará 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

Características Técnicas

• Requisitos 

...