[go: up one dir, main page]

About Clubs API

The Clubs API offers a robust framework for managing loyalty program clubs within the Clubs module. It facilitates seamless interaction between members and the club system. Through the endpoints of the Clubs API you can manage:

  • Club Templates: Use the API to retrieve available club templates designed for various use cases, such as Friends and Family, Sports Teams, or Business Groups. You can filter templates based on specific criteria to ensure your application selects the most suitable options for user needs.
  • Clubs: Access a list of clubs created from these templates, with filtering options for attributes such as status or type. This functionality streamlines navigation through available clubs and their detailed information.
  • Club Membership: Implement club membership management. The endpoints help handling join requests and invitations, and allowing owners to effectively add, remove, or approve members based on predefined criteria.
  • Point Collection and Spending: Use the endpoints to enable members to earn or spend points within their clubs, contributing to the overall club balance. This promotes collaboration among members, motivating them to achieve shared goals and rewards.

By leveraging the Clubs API, you can effectively implement collaborative loyalty programs that enhance member engagement and participation through structured goals and rewards.

API Principles

The FAQ API follows RESTful principles, utilizing standard HTTP methods to interact with resources. All responses are formatted in JSON, ensuring easy integration into user interfaces.

Security and Compliance

All server-to-server calls must comply with the API security protocol and signing procedure and adhere to the defined API rate limits.