Esta versão (v0.7) ainda não foi publicada no npm.
Pular para o conteúdo

Configuração e branding ​

O namespace config lê o que o operador configurou: moeda, limites e meios de pagamento (config.get), identidade visual (config.getBranding), produtos habilitados (config.getProducts) e o sportsbook (config.getSportsbook). Todos os métodos são públicos: não exigem login, enviam o token só quando há sessão e respondem pelo tenant do request (veja Tenant e domínios). O widget de suporte, também em config, tem página própria: Suporte (widget).

MétodoRotaDevolve
config.get()GET /configOperatorConfig: moeda, limites, meios de pagamento, captcha, OTP, idiomas
config.getBranding()GET /config/brandingBranding: nome, cores, logos, links legais, contato, PWA
config.getProducts()GET /config/productsProductsConfig: produtos com rota, ordem e status
config.getSportsbook()GET /config/sportsbookSportsbookConfig: provedor e configurações do FIRST

Configuração do operador: config.get ​

ts
import { formatMoney } from '@getenginex/sdk'

const config = await enginex.config.get()

config.currency // { code: 'BRL', symbol: 'R$', name: 'Real brasileiro', decimalPlaces: 2 }
config.languages // ['pt-BR']
config.features.casino // true when the casino is turned on

const pix = config.paymentMethods.find((method) => method.code === 'pix')
if (pix?.supportsDeposit) {
  console.log(`Minimum deposit: ${formatMoney(pix.minDeposit, config.currency, 'pt-BR')}`)
}
  • Dinheiro em centavos (unidades menores). limits e os valores de paymentMethods são inteiros em unidades menores (1000 é R$ 10,00 com decimalPlaces: 2). Formate com formatMoney e a currency do operador (veja Dinheiro).
  • limits: minBet/maxBet vêm sempre; os limites e taxas de depósito e saque só vêm quando o gateway identificou o operador.
  • captcha: se o cadastro exige captcha, o provedor e a siteKey pública (veja Cadastro).
  • otp: enabled e os flows que pedem código (ex.: register, withdraw_money).
  • timezone e defaultLanguage são opcionais: use-os para mostrar datas e escolher o primeiro idioma.

Um domínio que não pertence a nenhum operador rejeita com INVALID_ARGUMENT. Dinheiro ou moeda fora do formato rejeita com VALIDATION_ERROR, mesmo com validation: 'warn' (veja Validação de respostas).

Branding: config.getBranding ​

ts
const branding = await enginex.config.getBranding()

document.title = branding.operatorName
const root = document.documentElement
for (const [name, value] of Object.entries(branding.colors)) {
  // Colors the operator did not configure come as an empty string: keep the app's default.
  if (value !== '') root.style.setProperty(`--brand-${name}`, value)
}

const logo = document.querySelector<HTMLImageElement>('#logo')
if (logo) logo.src = branding.logos.logoFullDark
CampoO que traz
operatorId, operatorCode, operatorName, companyNamequem é o operador (nome de exibição e razão social)
colorsa paleta completa (primaryColor, backgroundColor, lightPrimaryColor, gradientCta...); cor não configurada vem ''
logoslogoFullLight (para fundo claro) e logoFullDark (para fundo escuro)
legalopcional: termsUrl, privacyUrl, responsibleGamblingUrl, cookiePolicyUrl e licenses
contactopcional: supportEmail, supportPhone e socialLinks (nome → URL)
pwaopcional: appName, appShortName e appDescription para o manifest
integrationsopcional: gtmId e os ids do Storyblok

Toda chave de cor existe em BrandingColors, então branding.colors.primaryColor é tipado sem encadeamento opcional; confira '' antes de usar um valor. legal, contact, pwa e integrations podem faltar: leia-os com ?..

Produtos: config.getProducts ​

ts
const { products } = await enginex.config.getProducts()

const menu = products
  .filter((product) => product.status === 'active')
  .sort((a, b) => a.displayOrder - b.displayOrder)
  .map((product) => ({ label: product.productName, href: product.routePath, icon: product.icon }))

Cada Product tem productType (ex.: casino, sportsbook, predictions), routePath, displayOrder, status e enabledFeatures, além de mapas livres (settings, limits em centavos, integrationSettings, featureConfig) cujas chaves o operador define. operatorId e operatorCode faltam quando o gateway não identificou o tenant. Use getProducts para montar o menu e as rotas; config.get().features só diz quais produtos estão ligados.

Sportsbook: config.getSportsbook ​

ts
const sportsbook = await enginex.config.getSportsbook()

if (sportsbook.enabled && sportsbook.provider === 'first' && sportsbook.config) {
  const { sportsbookUrl, language, currency, liveBettingEnabled } = sportsbook.config
  console.log(sportsbookUrl, language, currency, liveBettingEnabled)
}

config (as configurações do FIRST: siteId, sportsbookUrl, widgetUrl, language, currency, liveBettingEnabled, cashoutEnabled) só vem para o provedor FIRST. Montar o quadro e criar a sessão do jogador é com o iGaming: veja Sportsbook (FIRST).

Cache ​

A configuração muda pouco. Leia uma vez por app (ou por request no servidor) e guarde:

  • Com TanStack Query, as fábricas config.* de @getenginex/sdk/query trazem staleTime de 5 minutos e chave pública, compartilhada por todos os usuários (veja Frameworks).
  • No Next.js, faça o prefetch no layout com prefetchEnginex(enginex, (q) => [q.config.get(), q.config.getBranding()]), ou guarde a chamada em cache com fetchOptions: { next: { revalidate: 300 } } (veja Next.js e Extensibilidade).
ts
import { createQueries } from '@getenginex/sdk/query'

const q = createQueries(enginex)
q.config.getBranding() // { queryKey: ['enginex', 'public', 'config', 'getBranding'], queryFn, staleTime: 300_000 }

Testes ​

createMockFetch() responde às quatro rotas com um operador mock (BRL, PIX, um produto de cassino e FIRST ligado). Sobrescreva uma rota para testar outro operador:

ts
import { createEnginexClient } from '@getenginex/sdk'
import { createMockFetch, ok } from '@getenginex/sdk/testing'

const enginex = createEnginexClient({
  baseUrl: 'https://gateway.test',
  tenantHost: 'casino.test',
  fetch: createMockFetch({
    routes: { 'GET /api/v1/config/products': () => ok({ products: [] }) },
  }),
})

const { products } = await enginex.config.getProducts() // []

Veja Testes e mocks.