API Fundamentals

In this section you will learn more about the Open Loyalty API

General Concepts

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,500 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).

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

    • eu-west-1 (Ireland)

    • eu-central-1 (Frankfurt)

    • ap-southeast-1 (Singapore)

    • us-east-2 (USA)

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: Only available in eu-west-1 (Ireland).

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