LogoLogo
HomepageCase studiesBook a demo
Technical Guide
Technical Guide
  • Introduction
  • Getting Started Guide
    • Authentication
    • Member Registration Configuration
    • Add Webhook
    • Add Member
    • Create Campaign
    • Add Transaction
    • Add Custom Event Schema
    • Create Achievement
    • Add Custom Event
  • Terms Reference
  • Backward Compatibility Policy
  • API Reference
  • Postman Collection
  • User Guide
  • Integration
    • Introduction
    • Overview of Integration Methods
    • Tools and Technologies
    • Integration Examples
      • Lambda
      • Zapier
      • AWS EventBridge
      • Kafka
  • API Fundamentals
    • Overview
    • Environments Capabilities
    • How to Query
    • Limits
    • Best Practices
  • Authentication
    • Admin Token
    • Access Token (API Key)
    • Enabling SSO Login
      • Okta
      • Microsoft Entra ID
  • Webhooks
    • Overview
    • Best Practices
  • S3 Bucket Data exports
    • Overview
    • Set Up S3 Bucket Integration
    • Data Structure and Types
      • Achievements
      • Achievement Usage
      • Campaigns
      • Campaign Calculated Effect Result
      • Campaign Execution
      • Custom Events
      • Members
      • Rewards
      • Rewards Redemption
      • Tiers
      • Transactions
      • Tenants
      • Unit Transfers
Powered by GitBook
On this page
  • Commitment to No BC Breaks
  • Versioned Endpoints
  • MACH Principles Compliance
  • No-Downtime Guarantee During Upgrades
  • Staging Environment Updates

Was this helpful?

Backward Compatibility Policy

At Open Loyalty, we are committed to providing a stable and reliable platform for all our users. Ensuring that your experience is seamless and your operations remain uninterrupted is at the core of our development philosophy. Our Backward Compatibility (BC) Policy is designed to give you a clear understanding of how updates and changes are managed, ensuring that you can confidently build and scale your applications using Open Loyalty.

Commitment to No BC Breaks

We guarantee that our updates will not break backward compatibility. Every update comes with a changelog specifying relevant changes. After any update, all existing functionalities, APIs, and integrations will continue to work as expected. We aim to ensure that your applications and services remain unaffected by any changes we introduce.

Versioned Endpoints

We introduce any changes to our API through versioned endpoints to facilitate new features and improvements. This ensures that you can adopt new functionalities at your own pace without being forced to make immediate adjustments to your existing implementations. The versioning approach allows us to innovate while maintaining our users' stability. You will have three months to migrate or adjust your systems accordingly.

MACH Principles Compliance

Following the MACH (Microservices, API-first, Cloud-native, and Headless) principles, Open Loyalty ensures you always use our platform's latest version. We push changes several times weekly, focusing on enhancements contributing to Open Loyalty's scalability, performance, and flexibility.

No-Downtime Guarantee During Upgrades

We understand the importance of uptime for your business. Therefore, we provide a guarantee of no downtime during updates. Our deployment process is designed to apply updates seamlessly without interrupting the availability of Open Loyalty services.

Staging Environment Updates

All changes are rolled out to the staging environment and the production environment. This allows you to test and validate the updates in a controlled setting, ensuring no surprises when you decide to go live with new features. We encourage you to utilize the staging environment to maintain the stability and reliability of your applications.

Was this helpful?