Histórico da Página

...

Totvs custom tabs box

tabs	Interfaces utilizadas,Fluxo de operação,Opções de deploy
ids	interfaces,fluxo,deploy

Totvs custom tabs box items

default	yes
referencia	interfaces

São interfaces disponibilizadas na aplicação para uso na expansão das integrações:

Totvs custom tabs box

tabs	Autenticação,Integração
ids	authenticator,gateway

Totvs custom tabs box items

default	yes
referencia	authenticator

A interface IStrategyAuthenticator define as formas de autenticação que poderão ser usadas pela integração.

Totvs custom tabs box

tabs	Métodos visíveis,Propriedades
ids	methodsauth,propertiesauth

Totvs custom tabs box items

default	yes
referencia	methodsauth

function SetAuthURL(const AValue: string): IStrategyAuthenticator;
function SetParam(const AName, AValue: string): IStrategyAuthenticator;
function SetParams(const AValue: TStrings): IStrategyAuthenticator;
function Authenticate(out AToken: string): THTTPCode;

Totvs custom tabs box items

default	no
referencia	propertiesauth

ExpiresIn: Cardinal;
TokenType: string;

A interface IStrategyAuthContainer define o contêiner de armazenamento das definições de classes baseadas na interface IStrategyAuthenticator.

Totvs custom tabs box

tabs	Métodos visíveis,Propriedades
ids	methodscont,propertiescont

Totvs custom tabs box items

default	yes
referencia	methodscont

function AddAuthenticator(const AName: string; const AAuthenticator: TStrategyAuthenticatorClass): IStrategyAuthContainer;
function RemoveAuthenticator(const AName: string): IStrategyAuthContainer;
function Clear: IStrategyAuthContainer;
function SelectAuthenticator(const AName: string): IStrategyAuthContainer;
function SetAuthURL(const AValue: string): IStrategyAuthContainer;
function SetParam(const AName, AValue: string): IStrategyAuthContainer;
function Authenticate(out AToken: string): THTTPCode;

Totvs custom tabs box items

default	no
referencia	propertiescont

Authenticator[const AName: string]: IStrategyAuthenticator;
Authenticators: TArray<string>;

Totvs custom tabs box items

default	no
referencia	gateway

A interface IGatewayBase define as classes de integração que podem ser agregadas à API.

Totvs custom tabs box

tabs	Métodos visíveis,Propriedades
ids	methodsgw,propertiesgw

Totvs custom tabs box items

default	yes
referencia	methodsgw

function SetAuthenticator(const AAuthenticator: IStrategyAuthenticator): IGatewayBase;
function SetRedisConnector(const AValue: IRedisConnector): IGatewayBase;
function TreatRequest(const ARequest: TWebRequest; const AResponse: TWebResponse; const APathInfo: TArray<string>): THTTPCode;

Totvs custom tabs box items

default	no
referencia	propertiesgw

Não há propriedades expostas.

A interface IGatewayFactory define a estrutura que armazena as definições das classes baseadas na interface IGatewayBase.

Totvs custom tabs box

tabs	Métodos visíveis,Propriedades
ids	methodsfac,propertiesfac

Totvs custom tabs box items

default	yes
referencia	methodsfac

function GetResource(const AKey: string): IGatewayBase;
function RegisterResource(const AKey: string; const AResource: TGatewayBaseClass): IGatewayFactory;
function Resources: TArray<string>;

Totvs custom tabs box items

default	no
referencia	propertiesfac

Não há propriedades expostas.

Totvs custom tabs box items

default	no
referencia	fluxo

Este é o fluxo básico de operação das classes agregadas à API Gateway .

Totvs custom tabs box items

default	no
referencia	deploy

São opções de deploy da API Gateway:

Totvs custom tabs box

tabs	Microsoft Windows,Debian Linux e derivados,Docker/Podman
ids	windows,linux,docker

Totvs custom tabs box items

default	yes
referencia	windows

Totvs custom tabs box

tabs	Compilação,Configuração,Dependências
ids	compilacaocompilacaowin,configuracaoconfiguracaowin,dependenciasdependenciaswin

Totvs custom tabs box items

default	yes
referencia	compilacaocompilacaowin

A compilação pode ser feita para as seguintes arquiteturas:

32 bits (obsoleta)
64 bits

E deve obedecer a configuração Release.

Totvs custom tabs box items

default	no
referencia	configuracaoconfiguracaowin

As linhas a seguir devem ser adicionadas ao arquivo httpd.conf.

Bloco de código

title	httpd.conf

LoadModule cesgw_module modules/mod_cesgw.so

<IfModule cesgw_module>
  <Location /api/tlra/cesgw/v1>
    SetHandler mod_cesgw-handler
  </Location>
</IfModule>

Após a alteração do arquivo, é necessário reiniciar o servidor Apache.

Totvs custom tabs box items

default	no
referencia	dependenciaswin

A API depende diretamente do banco de dados Redis, devendo este ser instalado no mesmo servidor.

Totvs custom tabs box items

default	no
referencia	linux

Totvs custom tabs box

tabs	Compilação,Configuração,Dependências
ids	compilacaolin,configuracaolin,dependenciaslin

Totvs custom tabs box items

default	yes
referencia	compilalin

A compilação deve ser feita para a plataforma Linux 64 bits, usando a configuração Release.

Totvs custom tabs box items

default	no
referencia	configuracaolin

A configuração da API depende destes dois arquivos, os quais devem ser colocados no diretório /etc/apache2/mods-available.

Bloco de código

title	cesgw.load

LoadModule cesgw_module /usr/lib/apache2/modules/mod_cesgw.so

Bloco de código

title	cesgw.conf

<IfModule cesgw_module>
  <Location /api/tlra/cesgw/v1>
    SetHandler mod_cesgw-handler
  </Location>
</IfModule>

Após a cópia dos arquivos para o diretório indicado, a seguinte sequência de comandos deve ser executada:

# a2enmod cesgw
# systemctl restart apache2

Totvs custom tabs box items

default	no
referencia	dependenciaslin

A API depende diretamente do banco de dados Redis, devendo este ser instalado no mesmo servidor.

Totvs custom tabs box items

default	no
referencia	docker

...

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave