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
  • Production Environment
  • Staging Environment

Was this helpful?

  1. API Fundamentals

Environments Capabilities

Capabilities, Limitations, and Environment Differences

Production Environment

The production environment is fully equipped and ready to support your operational needs, ensuring your data and traffic are handled efficiently.

  • Uptime Guarantee: 99.9% uptime, ensuring reliable access.

  • Service Level Agreement (SLA): Comprehensive SLA coverage included.

  • Upgrades: Zero-downtime upgrades to minimize disruptions.

  • API Throughput: Supports up to 1,200 concurrent requests per second with a soft limit (If you plan to send more RPS, please contact OpenLoyalty to discuss viable solutions). Beyond this threshold, application performance may decrease.

    • Exceptions: The /api/admin/login_check and /api/token/refresh endpoints are limited to 20 requests per minute (RPM).

The number of the maximum concurrent RPS in your environment might be lower, depending on multiple factors.

We recommend using fewer than the maximum number of concurrent RPS as this number may be affected by the objects configured in Open Loyalty (e.g. the number of achievements or campaigns triggered by the API call).

  • Regional Availability: Services are available in the following regions:

    • eu-west-1 (Dublin, Ireland)

    • eu-central-1 (Frankfurt, Germany)

    • us-east-2 (Ohio, USA)

    • ap-southeast-1 (Singapore)

    • ap-southeast-2 (Sydney, Australia)

The region choice can affect your pricing. Please contact Open Loyalty for more information.

Staging Environment

The staging environment is designed for proof of concept (PoC) integration and functional testing. It is not intended for performance testing due to resource constraints.

  • Uptime & SLA: No guaranteed uptime or SLA provided.

  • Resources: Limited resources available, with no scaling options.

  • Upgrades: Zero-downtime upgrades are maintained.

  • Data Privacy: Storing personally identifiable information (PII) is not recommended.

  • API Throughput: Limited to 50 concurrent requests per second with a soft limit. Application performance may decrease beyond this limit.

    • Exceptions: The /api/admin/login_check and /api/token/refresh endpoints are limited to 20 RPM.

  • Regional Availability: Services are available in the following regions only:

    • eu-west-1 (Dublin, Ireland)

    • us-east-2 (Ohio, USA)

    • ap-southeast-2 (Sydney, Australia)

This delineation between environments ensures that you can develop and test with clarity, understanding the capabilities and limitations of each to best meet your development lifecycle needs.

Last updated 1 month ago

Was this helpful?