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étodo | Rota | Devolve |
|---|---|---|
config.get() | GET /config | OperatorConfig: moeda, limites, meios de pagamento, captcha, OTP, idiomas |
config.getBranding() | GET /config/branding | Branding: nome, cores, logos, links legais, contato, PWA |
config.getProducts() | GET /config/products | ProductsConfig: produtos com rota, ordem e status |
config.getSportsbook() | GET /config/sportsbook | SportsbookConfig: provedor e configurações do FIRST |
Configuração do operador: config.get
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).
limitse os valores depaymentMethodssão inteiros em unidades menores (1000é R$ 10,00 comdecimalPlaces: 2). Formate comformatMoneye acurrencydo operador (veja Dinheiro). limits:minBet/maxBetvê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 asiteKeypública (veja Cadastro).otp:enablede osflowsque pedem código (ex.:register,withdraw_money).timezoneedefaultLanguagesã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
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| Campo | O que traz |
|---|---|
operatorId, operatorCode, operatorName, companyName | quem é o operador (nome de exibição e razão social) |
colors | a paleta completa (primaryColor, backgroundColor, lightPrimaryColor, gradientCta...); cor não configurada vem '' |
logos | logoFullLight (para fundo claro) e logoFullDark (para fundo escuro) |
legal | opcional: termsUrl, privacyUrl, responsibleGamblingUrl, cookiePolicyUrl e licenses |
contact | opcional: supportEmail, supportPhone e socialLinks (nome → URL) |
pwa | opcional: appName, appShortName e appDescription para o manifest |
integrations | opcional: 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
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
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/querytrazemstaleTimede 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 comfetchOptions: { next: { revalidate: 300 } }(veja Next.js e Extensibilidade).
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:
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.