Árvore de páginas

Versões comparadas

Chave

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

...

Totvs custom tabs box
tabsInterfaces utilizadas,Fluxo de operação,Opções de deploy
idsinterfaces,fluxo,deploy
Totvs custom tabs box items
defaultyes
referenciainterfaces

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

Totvs custom tabs box
tabsAutenticação,Integração
idsauthenticator,gateway
Totvs custom tabs box items
defaultyes
referenciaauthenticator

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

Totvs custom tabs box
tabsMétodos visíveis,Propriedades
idsmethodsmethodsauth,propertiespropertiesauth
Totvs custom tabs box items
defaultyes
referenciamethodsmethodsauth
  • 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
defaultno
referenciapropertiespropertiesauth
  • 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
tabsMétodos visíveis,Propriedades
idsmethodsmethodscont,propertiespropertiescont
Totvs custom tabs box items
defaultyes
referenciamethodsmethodscont
  • 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
defaultno
referenciapropertiespropertiescont
  • Authenticator[const AName: string]: IStrategyAuthenticator;
  • Authenticators: TArray<string>;
Totvs custom tabs box items
defaultno
referenciagateway

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

Totvs custom tabs box
tabsMétodos visíveis,Propriedades
idsmethodsmethodsgw,propertiespropertiesgw
Totvs custom tabs box items
defaultyes
referenciamethodsmethodsgw
  • 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
defaultno
referenciapropertiespropertiesgw

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
tabsMétodos visíveis,Propriedades
idsmethodsmethodsfac,propertiespropertiesfac
Totvs custom tabs box items
defaultyes
referenciamethodsmethodsfac
  • function GetResource(const AKey: string): IGatewayBase;
  • function RegisterResource(const AKey: string; const AResource: TGatewayBaseClass): IGatewayFactory;
  • function Resources: TArray<string>;
Totvs custom tabs box items
defaultno
referenciapropertiespropertiesfac

Não há propriedades expostas.

Totvs custom tabs box items
defaultno
referenciafluxo

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

Totvs custom tabs box items
defaultno
referenciadeploy

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

Totvs custom tabs box
tabsMicrosoft Windows,Debian Linux e derivados,Docker/Podman
idswindows,linux,docker
Totvs custom tabs box items
defaultyes
referenciawindows
Totvs custom tabs box
tabsCompilação,Configuração,Dependências
idscompilacao,configuracao,dependencias
Totvs custom tabs box items
defaultyes
referenciacompilacao

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
defaultno
referenciaconfiguracao

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

Bloco de código
titlehttpd.conf
LoadModule cesgw_module modules/mod_cesgw.so

<IfModule cesgw_module>
  <Location /api/tlra/cesgw/v1>
    SetHandler mod_cesgw-handler
  </Location>
</IfModule>
Totvs custom tabs box items
defaultno
referencialinux


Totvs custom tabs box items
defaultno
referenciadocker


...