API GraphQL

La API GraphQL de Rewards está diseñada para soportar e impulsar la Biblioteca JavaScript Frontend de Rewards (SDK), que proporciona una experiencia de Rewards lista para usar y en continua evolución. Todas las marcas que usan Rewards tienen acceso a la API GraphQL, asegurando flexibilidad para diferentes necesidades técnicas y enfoques de integración.
Para la mayoría de casos de uso, recomendamos usar la Biblioteca JavaScript Frontend de Rewards (SDK). El SDK es mantenido activamente por el equipo de ingeniería de Rewards y se beneficia del desarrollo continuo de características, mejoras y corrección de errores. Al usar el SDK, las marcas pueden automáticamente aprovechar las nuevas funcionalidades cuando estén disponibles, sin necesidad de implementar o mantener estas características por sí mismas.
La API GraphQL puede usarse como complemento del SDK o como una solución independiente en casos donde se requiera funcionalidad personalizada que no esté actualmente soportada por el SDK. Al considerar el uso directo de la API GraphQL, es útil definir claramente el caso de uso previsto, ya que funcionalidad similar o equivalente puede ya existir o estar planeada dentro del SDK.
Elegir el SDK permite a las marcas enfocarse en su experiencia central mientras confían en un equipo dedicado de Rewards para gestionar las características subyacentes del frontend de Rewards. Las marcas que construyen un frontend de Rewards completamente personalizado usando la API GraphQL obtienen mayor control y flexibilidad, pero también serán responsables de implementar y mantener nuevas características de extremo a extremo cuando sean introducidas.
Este documento proporciona una referencia técnica completa para integrar con la API GraphQL de Fasttrack Rewards. Cubre autenticación usando tokens JWT, consultas y mutaciones disponibles para acceder y gestionar recompensas, bonificaciones, desafíos, artículos de tienda y datos de usuario, así como suscripciones en tiempo real. Los desarrolladores pueden usar esta guía para entender el esquema, construir solicitudes de API e implementar las características de recompensas.

🌟 Playground:

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

🔒 Autenticación

Para acceder a la API:
  1. Debes pasar un token JWT con las siguientes declaraciones:
    1. iat (Issued At): Marca de tiempo Unix
    2. exp (Expiration): Marca de tiempo Unix
    3. user_id: String o entero
  2. El JWT debe estar firmado con el JWT-secret proporcionado a Fasttrack.
En el Playground:
  1. Ve a la sección Headers.
  2. Añade: