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: