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

Suporte (widget) ​

O suporte ao jogador é um widget de terceiros (Zendesk, Intercom...) configurado pelo operador. O SDK não tem um namespace de suporte: o que existe é config.getSupport(), que devolve o que o app precisa para montar o widget. Não exige login.

Ler a configuração ​

ts
const support = await enginex.config.getSupport()
// { enabled: true, provider: 'zendesk', supportType: 'zendesk', widgetUrl: 'https://...', apiKey: '...' }

Sem type, o gateway devolve o Zendesk. Para outro provedor, passe { type: 'intercom' }.

CampoPara quê
enabledfalse quando o operador não configurou: não monte nada
providercódigo do provedor
supportTypetipo pedido, ex.: zendesk, intercom
widgetUrlURL do script do widget
apiKeychave que o gateway diz ser necessária para iniciar o widget
appIdidentificador do app (depende do provedor configurado)
widgetIdidentificador do widget (depende do provedor configurado)
domaindomínio (depende do provedor configurado)

Todos, menos enabled, são opcionais: só vêm quando o operador os preencheu. O gateway não diz qual campo cada provedor usa; confira com o operador e com a documentação do provedor.

Montar o widget ​

O padrão é o mesmo para qualquer provedor: carregar o script do provedor com o que o gateway devolveu e inicializá-lo. Os exemplos abaixo são genéricos; confira a API do widget na documentação do seu provedor, porque o SDK não a conhece nem a valida.

ts
// Loads a script once and resolves when it is ready.
function loadScript(src: string, id: string): Promise<void> {
  return new Promise((resolve, reject) => {
    if (document.getElementById(id)) return resolve()
    const el = document.createElement('script')
    el.id = id
    el.src = src
    el.async = true
    el.onload = () => resolve()
    el.onerror = () => reject(new Error('Failed to load the support widget'))
    document.head.append(el)
  })
}

Zendesk (exemplo) ​

ts
const support = await enginex.config.getSupport({ type: 'zendesk' })
if (support.enabled && support.widgetUrl) {
  await loadScript(support.widgetUrl, 'support-widget')
  // After loading, initialize the widget as the Zendesk documentation says, with what the operator
  // configured (for example, `support.apiKey`).
}

Outro provedor (exemplo ilustrativo) ​

O exemplo abaixo só ilustra o padrão com type: 'intercom'. Quais campos o seu provedor exige (aqui, appId) é uma suposição do exemplo, não uma garantia do gateway.

ts
const support = await enginex.config.getSupport({ type: 'intercom' })
if (support.enabled && support.widgetUrl && support.appId) {
  // The script URL comes from the gateway. Any provider URL pattern belongs to the provider: the SDK
  // and the gateway do not supply it.
  await loadScript(support.widgetUrl, 'support-widget')
  // Initialize as the provider's documentation says (here, assuming `appId` is what is needed).
}

Boas práticas:

  • Monte o widget uma vez (por exemplo, no layout raiz) e só se enabled for true.
  • Trate a falha do script (bloqueador de anúncios, rede): o app precisa seguir funcionando sem o suporte, talvez com um link de contato alternativo.
  • O gateway só diz que apiKey é necessária para iniciar o widget; não assuma que ela é pública nem secreta além disso, e use-a apenas como o provedor documenta.
  • Não envie ao provedor dados do jogador que o operador não autorizou (e-mail, CPF); identifique o jogador pelo que a política de privacidade do operador permitir.

Tickets de suporte: fora desta versão ​

O gateway tem rotas de tickets (/support/tickets), mas o SDK não as expõe, porque hoje elas não funcionam de ponta a ponta:

  • as chamadas de criar, listar e responder tickets não estão implementadas no serviço administrativo (enginex-admin) que está no workspace;
  • o gateway envia source: "web" ao criar um ticket, um valor que o serviço não aceita;
  • não há rota para ler as respostas da equipe nem para fechar um ticket.

Expor isso agora levaria o app a uma tela de tickets que falha. Quando o gateway e o serviço estiverem completos, os tickets entram numa versão futura. Até lá, o canal é o widget.

O que o gateway ainda não oferece ​

  • Tickets de suporte. Criar, listar, ler respostas e fechar; veja acima.
  • Configuração tipada por provedor. getSupport devolve campos genéricos opcionais; o SDK não sabe qual é obrigatório em cada provedor.
  • Identificação do jogador no widget. Não há token de identidade (por exemplo, assinatura de usuário) gerado pelo gateway para o provedor.