Histórico da Página

...

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.

...

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 Padrão 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.

...

Estrutura base de acesso: http://IP:PORTA/api/entity/[apiVersion]/[pathUrl]  
Exemplo de uma Entidade: http://127.0.0.1:8080/api/entity/v1/unidadesMedidaInd?page=1&pagesize=1

• • Query - Destinado a consultas e à obtenção de dados específicos previamente definidos pela equipe de produto. 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=5

...

Perguntas Frequentes (FAQ)

...

O TOTVS Agro API Hub está homologado para execução no sistema operacional Windows Server. A seguir, são descritas as versões do Windows atualmente suportadas

• • Windows Server 2019 Standard;
  • Windows Server 2022 Standard;

Plataforma Java (JDK/JRE)

O TOTVS Agro API Hub faz uso da plataforma Java, como ambiente de execução, na versão OpenJDK 21.0.2 (versão opensource do Java, que não demanda por licenciamento).

O conjunto de binários utilizado é fornecido durante a instalação e configuração do TOTVS Agro API Hub.

Requisitos de Banco de Dados

TOTVS Agro API HUB

O TOTVS Agro API Hub utiliza o banco de dados PostgreSQL para armazenar sua estrutura

...

• PostgreSQL  
  • PostgreSQL 15 (versão recomendada)

Bases de dados - TOTVS Agro API Hub

...

CREATE TABLESPACE PIMS_DATA DATAFILE '/u01/oradata/orcl/PIMS_DATA.ORA' SIZE 20G;

CREATE TABLESPACE PIMS_INDX DATAFILE '/u01/oradata/orcl/PIMS_INDEX.ORA' SIZE 20G;

CREATE USER {{DB_USUARIO_API_HUB_BIO}} IDENTIFIED BY "{{DB_SENHA_API_HUB}}" DEFAULT TABLESPACE PIMS_DATA TEMPORARY TABLESPACE TEMP PROFILE DEFAULT ACCOUNT UNLOCK;  
 
GRANT CONNECT                    TO {{DB_USUARIO_API_HUB}};
GRANT "RESOURCE                  TO {{DB_USUARIO_API_HUB}};
GRANT UNLIMITED TABLESPACE       TO {{DB_USUARIO_API_HUB}};
GRANT DEBUG CONNECT SESSION      TO {{DB_USUARIO_API_HUB}};
GRANT DEBUG ANY PROCEDURE        TO {{DB_USUARIO_API_HUB}};  
GRANT CREATE SYNONYM             TO {{DB_USUARIO_API_HUB}};
GRANT CREATE VIEW                TO {{DB_USUARIO_API_HUB}};
GRANT CREATE PROCEDURE           TO {{DB_USUARIO_API_HUB}}; 
GRANT CREATE TRIGGER             TO {{DB_USUARIO_API_HUB}};
GRANT CREATE SEQUENCE            TO {{DB_USUARIO_API_HUB}}; 
GRANT CREATE MATERIALIZED VIEW   TO {{DB_USUARIO_API_HUB}};
GRANT UNLIMITED TABLESPACE       TO {{DB_USUARIO_API_HUB}};
 
ALTER USER {{DB_USUARIO_API_HUB}} QUOTA UNLIMITED ON PIMS_DATA;
ALTER USER {{DB_USUARIO_API_HUB}} QUOTA UNLIMITED ON PIMS_INDX;

GRANT CONNECT ON DATABASE <NOME_DO_BANCO> TO <NOME_DO_USUARIO>;,
GRANT CREATE, USAGE ON SCHEMA <NOME_DO_SCHEMA> TO <NOME_DO_USUARIO>;,
GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA <NOME_DO_SCHEMA> TO <NOME_DO_USUARIO>;,
ALTER DEFAULT PRIVILEGES IN SCHEMA <NOME_DO_SCHEMA> GRANT ALL ON TABLES TO <NOME_DO_USUARIO>;,
GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA <NOME_DO_SCHEMA> TO <NOME_DO_USUARIO>;,
ALTER DEFAULT PRIVILEGES IN SCHEMA <NOME_DO_SCHEMA> GRANT ALL ON SEQUENCES TO <NOME_DO_USUARIO>;,
ALTER DEFAULT PRIVILEGES IN SCHEMA <NOME_DO_SCHEMA> GRANT ALL ON FUNCTIONS TO <NOME_DO_USUARIO>;

Bases de dados - externas

É possível utilizar bases de dados de múltiplos produtos externos (mínimo de 1 e máximo de 3), como TOTVS Agro Bioenergia (obrigatório), Indústria MI (opcional) e Indústria PI (opcional). Para o processo de habilitação (instalação, configuração e uso) do API Hub com o TOTVS Agro Bioenergia, a versão mínima requerida do banco de dados é Oracle 19c.

• •  Oracle 
    • Banco de dados homologados
  para o
  • • - TOTVS Agro Bioenergia e TOTVS Agro Indústria
    • Conexão com a Base de Dados do Produto
      

• • Permissão de Banco

    Bloco de código
    language sql theme Confluence title Permissões (Oracle / TOTVS Agro Bioenergia) linenumbers true
    GRANT CONNECT TO "NOME_OWNER"; GRANT RESOURCE TO "NOME_OWNER"; GRANT UNLIMITED TABLESPACE TO "NOME_OWNER"; GRANT CREATE SYNONYM TO "NOME_OWNER"; GRANT CREATE VIEW TO "NOME_OWNER"; GRANT CREATE PROCEDURE TO "NOME_OWNER"; GRANT CREATE TRIGGER TO "NOME_OWNER"; GRANT CREATE SEQUENCE TO "NOME_OWNER"; GRANT CREATE MATERIALIZED VIEW TO "NOME_OWNER GRANT CREATE ANY TABLE TO ""NOME_OWNER"; GRANT ALTER ANY TABLE  TO "NOME_OWNER"; GRANT INSERT ANY TABLE TO "NOME_OWNER"; GRANT UPDATE ANY TABLE TO "NOME_OWNER"; GRANT DELETE ANY TABLE TO "NOME_OWNER"; GRANT SELECT ANY TABLE TO "NOME_OWNER"; GRANT CREATE ANY TRIGGER TO "NOME_OWNER";

Requisitos de Acesso Externo

...