Skip to main content
Cada benefício integrado precisa declarar um arquivo de JSON de metadados que descreve suas informações básicas, parâmetros de autenticação, opções configuráveis e as ações que ele suporta. Esse arquivo serve para suprir metadados sobre o Benefício, que ficarão disponíveis no portal benStore, informando o que é necessário para a o uso do benefício (por exemplo: tokens, URLs de API, parâmetros adicionais etc).

Estrutura do Template

O arquivo benefit.manifest.json possui os campos necessário para descrever todos os dados necessárias.

Descrição

🔹 benefitName: Nome comercial do benefício. 🔹 auth: Lista de informação que a integração benSDK utilizará para autenticação que é configurável via portal benStore. Cada item representa uma variável para sua autenticação (como token, URL, client ID, etc). 🔹 availiableActions: Determina quais ações são automatizadas no benefício, elas se tornam configuráveis pelo portal benStore. Geralmente é o mesmo definido no benefit-definition.ts. 🔹 options: Define parâmetros que podem ser personalizados no portal benStore, e ficará disponível para uso no SDK. Eles são exibidos na interface do portal e podem alterar o comportamento do benefício.
  • key: identificador único do campo
  • label: nome exibido no painel
  • type: tipo do valor (BOOLEAN, TEXT, MAP, etc)
  • jsonSchema: validação do valor informado

Onde o Template é Usado

Durante a integração, usamos para:
  • Montar automaticamente a tela de configuração do benefício;
  • Validar credenciais e parâmetros antes de inicializar a execução;
  • Exibir o benefício corretamente no catálogo do portal benStore.

Ícone do benefício

É importante definir uma imagem PNG substituindo o arquivo ICON.png placeholder na raiz do projeto. Esse ícone será usado pelo portal benStore.

Exemplo