API GraphQL

La API GraphQL de Recompensas está diseñada para soportar y potenciar la Biblioteca JavaScript del Front End de Recompensas (SDK), que proporciona una experiencia de Recompensas lista para usar y en constante evolución. Todas las marcas que utilizan Recompensas 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 utilizar la Biblioteca JavaScript del Front End de Recompensas (SDK). El SDK es mantenido activamente por el equipo de ingeniería de Recompensas y se beneficia del desarrollo continuo de características, mejoras y correcciones de errores. Al usar el SDK, las marcas pueden aprovechar automáticamente la nueva funcionalidad a medida que esté disponible, sin la necesidad de implementar o mantener estas características por sí mismas.
La API GraphQL puede ser utilizada 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 planificada dentro del SDK.
Elegir el SDK permite a las marcas enfocarse en su experiencia principal mientras confían en un equipo dedicado de Recompensas para gestionar las características subyacentes del front-end de Recompensas. Las marcas que construyan un front-end de Recompensas completamente personalizado utilizando la API GraphQL obtendrán mayor control y flexibilidad, pero también serán responsables de implementar y mantener nuevas características de extremo a extremo a medida que 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, bonos, 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 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: Cadena 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: