API GraphQL

A API GraphQL do Rewards foi projetada para suportar e alimentar a Biblioteca JavaScript Front End do Rewards (SDK), que fornece uma experiência de Rewards pronta para uso e em constante evolução. Todas as marcas que usam o Rewards têm acesso à API GraphQL, garantindo flexibilidade para diferentes necessidades técnicas e abordagens de integração.
Para a maioria dos casos de uso, recomendamos usar a Biblioteca JavaScript Front End do Rewards (SDK). O SDK é mantido ativamente pela equipe de engenharia do Rewards e se beneficia do desenvolvimento contínuo de recursos, melhorias e correções de bugs. Ao usar o SDK, as marcas podem automaticamente aproveitar novas funcionalidades conforme elas se tornam disponíveis, sem a necessidade de implementar ou manter essas funcionalidades por conta própria.
A API GraphQL pode ser usada como um complemento ao SDK ou como uma solução independente em casos onde funcionalidade personalizada é necessária que não é atualmente suportada pelo SDK. Ao considerar o uso direto da API GraphQL, é útil definir claramente o caso de uso pretendido, pois funcionalidade similar ou equivalente pode já existir ou estar planejada dentro do SDK.
Escolher o SDK permite que as marcas se concentrem em sua experiência principal enquanto dependem de uma equipe dedicada do Rewards para gerenciar as funcionalidades subjacentes do front-end do Rewards. Marcas que constroem um front-end totalmente personalizado do Rewards usando a API GraphQL ganham maior controle e flexibilidade, mas também serão responsáveis por implementar e manter novas funcionalidades end-to-end conforme elas são introduzidas.
Este documento fornece uma referência técnica completa para integração com a API GraphQL do Fasttrack Rewards. Ele cobre autenticação usando tokens JWT, consultas e mutações disponíveis para acessar e gerenciar recompensas, bônus, desafios, itens da loja e dados do usuário, bem como assinaturas em tempo real. Desenvolvedores podem usar este guia para entender o esquema, construir solicitações de API e implementar as funcionalidades de recompensas.

🌟 Playground:

Playground: https://<brand-name>.ft-crm.com/rewards-graphql-api/

🔒 Autenticação

Para acessar a API:
  1. Você deve passar um token JWT com as seguintes claims:
    1. iat (Emitido Em): Timestamp Unix
    2. exp (Expiração): Timestamp Unix
    3. user_id: String ou inteiro
  2. O JWT deve ser assinado com o JWT-secret fornecido ao Fasttrack.
No Playground:
  1. Vá para a seção Headers.
  2. Adicione: