# llms.txt

## Table of contents

 - [Tiers v2 API](https://annexcloud.redocly.app/tiersv2/tiersv2.md): Welcome to the Tiers API Documentation for Annex Cloud's cutting-edge loyalty program platform. Our Tiers API empowers developers, businesses, and partners to seamlessly integrate and enhance their applications with our dynamic and customizable loyalty tiers system. This API documentation serves as your comprehensive guide to understanding and implementing the Tiers API, unlocking the full potential of loyalty-driven engagement for your customers. Whether you're looking to reward long-term patrons, incentivize higher spending, or create personalized experiences for your member base, our Tiers API offers a versatile solution that aligns with your unique business goals.
 - [Webhooks Events](https://annexcloud.redocly.app/webhook-events/webhooks.md): Welcome to the Webhook API Documentation for Annex Cloud! This guide is designed to help developers, administrators, and system integrators seamlessly configure and manage webhook integrations within the Annex Cloud platform. Webhooks play a critical role in enabling real-time, event-driven communication between Annex Cloud and your external systems, ensuring that important events are delivered instantly and reliably. The Webhook API allows you to subscribe to specific platform event such as data creation or updates and automatically push structured payloads to your designated endpoints. Whether you’re synchronizing user data with downstream systems, triggering workflows in third-party applications, or monitoring activity across your ecosystem, webhooks provide a scalable and efficient integration mechanism without the need for continuous polling. This documentation walks you through the complete lifecycle of webhook management, including creating and validating webhook configurations, retrieving and managing existing webhooks, enabling or disabling them as needed, and permanently removing obsolete configurations. You’ll also find details on retry behavior, timeout settings, supported event types, and pagination to help you build resilient and production-ready integrations. Whether you are new to event-based integrations or an experienced developer building complex system architectures, this guide is structured to offer both conceptual clarity and practical implementation details. With clear endpoint definitions, request and response schemas, and real-world examples, the Webhook API documentation equips you to confidently extend Annex Cloud’s capabilities into your broader technology stack.
 - [Rewards V2](https://annexcloud.redocly.app/allrewards/allrewards.md): The Rewards API serves as a crucial component of modern customer engagement strategies, enabling businesses to effectively manage and distribute rewards to their members. Its primary purpose is to facilitate the retrieval, assignment, and management of various rewards, which can significantly enhance user experience and drive customer loyalty. By providing a seamless integration with Reward systems, this API allows organizations to offer personalized incentives that cater to individual preferences and behaviors. In the broader context of a rewards system, the Rewards API plays a pivotal role in fostering customer engagement. Rewards not only incentivize purchases but also encourage repeat interactions with the brand. By leveraging the capabilities of this API, businesses can create dynamic reward programs that resonate with members, thereby increasing customer satisfaction and retention. The ability to offer personalized rewards enhances the relevance of marketing efforts and strengthens the emotional connection between the brand and its customers, ultimately leading to higher conversion rates and improved brand loyalty.
 - [Badge API](https://annexcloud.redocly.app/badges/badges.md): The Badges API serves as an essential tool for modern customer engagement and gamification strategies, empowering businesses to design, manage, and track badge systems that motivate member behavior and recognize achievements. Its primary function is to facilitate the seamless retrieval, filtering, and categorization of badges, which can be used to enhance member experiences and foster loyalty through meaningful recognition and rewards. By integrating with this API, organizations can implement dynamic and personalized badge programs tailored to specific member actions and milestones. In the broader context of gamification and engagement systems, the Badges API plays a critical role in driving member participation and retention. Badges act as visual representations of achievement and progress, encouraging members to interact more frequently with the platform and strive for higher goals. By leveraging the API's capabilities, businesses can design badge programs that align with their brand values and member expectations, fostering a sense of accomplishment and belonging. Personalized badges not only enhance the member's connection to the brand but also strengthen long-term loyalty, making the Badges API a cornerstone for creating compelling and effective engagement strategies.
 - [Events API](https://annexcloud.redocly.app/ev/ev.md): Annex Cloud’s Incentive Engine helps to create rewards that can be used as marketing incentives by businesses either with loyalty programs or without loyalty programs. The benefits of these types of incentives could include a certain percentage off on a purchase or a specific amount discount. This type of incentive engine is used to attract and retain customers. Annex Cloud incentive engine offers two types of redemptions- Full Redemption & Partial Redemption Full Redemption- Full redemption yields the reward points on a comprehensive basis. The redeemed incentives can offer discounts as a percentage or in the form of a fixed rate coupon. The format of the rewards can be provided as coupon codes and voucher codes. Partial Redemption- A partial redemption allows rewards to be redeemed in portions - leaving the rest available to be redeemed later. This includes a redemption of rewards in the form of gift cards and store cards.
 - [Incentive Engine V3 APIs](https://annexcloud.redocly.app/iem/iem.md): Annex Cloud’s Incentive Engine helps to create rewards that can be used as marketing incentives by businesses either with loyalty programs or without loyalty programs. The benefits of these types of incentives could include a certain percentage off on a purchase or a specific amount discount. This type of incentive engine is used to attract and retain customers. Annex Cloud incentive engine offers two types of redemptions- Full Redemption & Partial Redemption Full Redemption- Full redemption yields the reward points on a comprehensive basis. The redeemed incentives can offer discounts as a percentage or in the form of a fixed rate coupon. The format of the rewards can be provided as coupon codes and voucher codes. Partial Redemption- A partial redemption allows rewards to be redeemed in portions - leaving the rest available to be redeemed later. This includes a redemption of rewards in the form of gift cards and store cards.
 - [introduction.md](https://annexcloud.redocly.app/introduction-1.md)
 - [Journey APIs](https://annexcloud.redocly.app/jr/jr.md): The Journey API provides a powerful way for customers to access and understand the engagement paths that members follow within the platform. A journey represents a structured flow of interactions, such as earning points, receiving rewards, being enrolled in campaigns, or completing specific actions triggered by predefined events. These journeys are designed to enhance the member experience by guiding them through meaningful interactions with your brand. The API offers capabilities to retrieve both system-wide journey definitions and individual member-specific journey participation details. Customers can gain visibility into which journeys are currently active, how they are structured, and which members are part of them. This information can be used to monitor engagement, troubleshoot issues, personalize communication, and improve campaign effectiveness. By leveraging the Journey API, customers can - - View all configured journeys – Understand the journeys that exist within the platform, including their goals, triggers, and statuses. - Access detailed journey information – Drill down into specific journeys to see how they are configured and managed. - Track member-level participation – Retrieve data on which journeys a specific member is enrolled in, their progress, and any related events. - Support data-driven personalization – Use journey data to tailor messaging, offers, or experiences based on where a member is in their engagement lifecycle. - Enable efficient member support – Provide customer support teams with insights into a member's journey activity to help resolve inquiries more effectively.
 - [Loyalty APIs](https://annexcloud.redocly.app/jwt/jwt.md): Introduction This document provides a comprehensive guide for implementing Client Access Token authentication using JSON Web Tokens (JWT) when integrating with Annex Cloud public APIs. JWT authentication ensures that every request is secure, verifiable, and tamper-proof by combining a signed HMAC (Hash-based Message Authentication Code) with a shared secret. This mechanism helps maintain - - Data integrity - API requests cannot be altered without detection. - Authentication - Validates that requests originate from trusted clients. - Stateless interaction - Tokens carry the necessary authentication data without relying on server-side sessions. By following this guide, you will be able to generate tokens, validate requests, and interact securely with Annex Cloud APIs using a standardized process. Overview The Client Access Token is a JSON Web Token (JWT) signed with the HMAC-SHA256 algorithm. It contains required claims such as - - sub - Client identifier - exp - Expiration timestamp (Unix format) - site_id - Annex Cloud site ID - hmac - Base64-encoded HMAC generated from the request payload (POST or PATCH) or query parameters (GET) This document provides: - JWT structure and components (header, payload, signature) - HMAC generation rules for POST, PATCH, and GET requests - Code samples in PHP, Java, and Python - Required HTTP headers for authenticating API calls Supported Libraries - PHP - firebase/php-jwt - Java - io.jsonwebtoken jjwt, org.json, jaxb-api - Python - PyJWT (jwt on PyPI) Using these libraries, you can generate JWTs, sign them with your shared secret, and include them as Bearer tokens in API requests for secure authentication. Example format - Header.Payload.Signature Where - - Header - Contains metadata such as algorithm and token type - Payload - Contains claims (sub, exp, site_id, hmac) - Signature - Created using HMAC-SHA256 and the shared secret
 - [Multi-Point Bucket V3 APIs](https://annexcloud.redocly.app/mpb/mpb.md): Welcome to the Multi Point Bucket (MPB) API documentation for Annex Cloud, the Multi Point Bucket feature is a powerful tool available in various API’s such as Tiers, Orders, Rewards, Points, Products, and Cart. The MPB feature allows for the creation of multiple buckets for points, each representing a different type or purpose. This enables users to track and manage points more effectively, ensuring that they are allocated correctly according to the defined rules and criteria. Using the MPB feature with the GET, POST and PATCH methods, users can define criteria based on products and orders to determine eligibility for earning or redeeming points and rewards. For example, users can set rules that specify which products or categories of products are eligible for earning points towards the additional point buckets or establish thresholds for the minimum purchase amount required to earn points. Overall, the Multi Point Bucket feature enhances the functionality of various API’s by providing a flexible and customizable solution for configuring eligibility criteria for members associated with points, rewards, tiers, products, and orders. This allows businesses to create loyalty programs and rewards systems that are tailored to meet the unique needs of their customers and drive engagement and loyalty.
 - [Loyalty APIs](https://annexcloud.redocly.app/loyalty/loyalty.md): Customer loyalty drives successful enterprises, representing the trust and emotional connection consumers develop with brands over time. In today's competitive landscape with evolving customer expectations, retaining existing customers is as crucial as attracting new ones. Our Customer Loyalty API revolutionizes customer engagement by enabling seamless integration of loyalty programs into your applications, websites, and platforms. This solution empowers businesses of all sizes with personalized experiences, targeted rewards, and data-driven insights to enhance customer lifetime value. This documentation guides you through integration with detailed explanations, endpoints, examples, and best practices suitable for both newcomers and experienced developers. Key Features- Customer Enrollment - Easily register customers with minimal API calls Points and Rewards Management - Track points and incentivize engagement Personalized Promotions - Create targeted offers based on individual preferences Data Analytics - Gain insights into customer behavior for informed decisions Security and Compliance - Protect customer data with robust security measures Seamless Integration - Compatible with various platforms for hassle-free implementation
 - [Privacy Policy Management V3 APIs](https://annexcloud.redocly.app/ppm/ppm.md): General Data Protection Regulation (GDPR) and the California Consumer Privacy Act (CCPA) define that consumer/data subjects have the right to view, update, extract, and delete the data that controllers and business have saved on them. When the consumer/data subject exercises their rights they create a data request. These APIs are used to delete the members from one or multiple sites by using the DELETE request method and if the user wants to revoke his account, then it can be done with the help of the PUT request method.
 - [Registration as a Service V3 APIs](https://annexcloud.redocly.app/raas/raas.md): Registration As A Service (RaaS) is an end-to-end user management platform. RaaS offers a comprehensive cloud-based user registration system that supports social login, allowing sites to maintain a unified user database for both social and traditional sites. Login credentials are a necessary component of customer loyalty and native identity services makes adding login easy. Add full registration as service to your site or enhance your site or enhance your existing registration process with social login or single sign-on. The User API is used to register and update information in the RaaS module.
 - [Refer a Friend V3 APIs](https://annexcloud.redocly.app/raf/raf.md): Thank you for choosing our Refer a Friend API to enhance your application's referral capabilities. This comprehensive documentation is designed to guide you through the seamless integration of our powerful referral system into your platform, allowing your users to effortlessly refer friends and unlock a world of rewards. Our team is committed to providing excellent developer support, so if you encounter any challenges or have any questions, please don't hesitate to reach out to us. We want to ensure that your experience with the Refer a Friend API is seamless and successful. So, let's get started and unlock the full potential of referral marketing together. A detailed explanation of the Refer a Friend User API and the examples are shown below.
 - [Tenant V3 APIs](https://annexcloud.redocly.app/tenant/tenant.md): The Tenant APIs provided by Annex Cloud allow developers to manage user-related operations with ease. With these APIs, you can perform various actions such as creating and updating user information, fetching user profiles, and generating JWT tokens for secure API interactions. Key Features of Tenant APIs are User Management- Create, update, and retrieve user information seamlessly. Profile Access- Fetch detailed user profile information. JWT Token Generation- Secure your API requests by generating JWT tokens. Methods for Using Tenant APIs- One-step Method- In the one-step method, the token is generated and executed against the payload in a single operation. This approach simplifies the process by combining token generation and API execution in one step. Two-step Method-The two-step method provides more control by requiring token generation for each API method separately. After generating the token, it must be replaced by the user for every API call. Each token can be used only once. Attempting to reuse a token will result in an "Expired token" error. These methods offer flexibility depending on your security and operational needs, ensuring that your interactions with the Annex Cloud platform are both secure and efficient.
 - [Rewards](https://annexcloud.redocly.app/rewardsv2/rewardsv2.md): The Rewards API serves as a crucial component of modern customer engagement strategies, enabling businesses to effectively manage and distribute rewards to their members. Its primary purpose is to facilitate the retrieval, assignment, and management of various rewards, which can significantly enhance user experience and drive customer loyalty. By providing a seamless integration with Reward systems, this API allows organizations to offer personalized incentives that cater to individual preferences and behaviors. Key features of the Rewards API include the ability to list rewards based on specific criteria, retrieve detailed information about each reward, and assign rewards to members with ease. The API supports various data types and parameters for filtering rewards, ensuring that businesses can tailor their offerings to meet the unique needs of their customer base. Furthermore, the API includes robust error handling and validation mechanisms, which help maintain data integrity and improve overall system performance. In the broader context of a rewards system, the Rewards API plays a pivotal role in fostering customer engagement. Rewards not only incentivize purchases but also encourage repeat interactions with the brand. By leveraging the capabilities of this API, businesses can create dynamic reward programs that resonate with members, thereby increasing customer satisfaction and retention. The ability to offer personalized rewards enhances the relevance of marketing efforts and strengthens the emotional connection between the brand and its customers, ultimately leading to higher conversion rates and improved brand loyalty.
 - [Webhook Events API](https://annexcloud.redocly.app/web/web.md): API for handling point balance updates and group events.
 - [Webhooks APIs](https://annexcloud.redocly.app/webhooks/webhooks.md): Welcome to the Webhook API Documentation for Annex Cloud! This guide is designed to help developers, administrators, and system integrators seamlessly configure and manage webhook integrations within the Annex Cloud platform. Webhooks play a critical role in enabling real-time, event-driven communication between Annex Cloud and your external systems, ensuring that important events are delivered instantly and reliably. The Webhook API allows you to subscribe to specific platform event such as data creation or updates and automatically push structured payloads to your designated endpoints. Whether you’re synchronizing user data with downstream systems, triggering workflows in third-party applications, or monitoring activity across your ecosystem, webhooks provide a scalable and efficient integration mechanism without the need for continuous polling. This documentation walks you through the complete lifecycle of webhook management, including creating and validating webhook configurations, retrieving and managing existing webhooks, enabling or disabling them as needed, and permanently removing obsolete configurations. You’ll also find details on retry behavior, timeout settings, supported event types, and pagination to help you build resilient and production-ready integrations. Whether you are new to event-based integrations or an experienced developer building complex system architectures, this guide is structured to offer both conceptual clarity and practical implementation details. With clear endpoint definitions, request and response schemas, and real-world examples, the Webhook API documentation equips you to confidently extend Annex Cloud’s capabilities into your broader technology stack.