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

Was this helpful?

  1. API Fundamentals

Overview

Last updated 4 months ago

Was this helpful?

API Integration involves using to establish direct communication between your systems and Open Loyalty. use standard HTTP methods (GET, POST, PUT, DELETE) and JSON data format for request and response payloads.

To ensure secure communication, you need to authenticate requests using mechanisms such as API keys or OAuth 2.0 tokens.

  • : Unique identifiers that authenticate requests on behalf of a specific user or application. They should be kept secure and never exposed in a client-side code.

  • : An industry-standard protocol for authorization, enabling third-party applications to obtain limited access to a user's resources without exposing their credentials. OAuth 2.0 uses access tokens and refresh tokens for secure and controlled access to resources.

Learn more about:

RESTful APIs
Our API
API Keys
OAuth 2.0
Admin Token
Access Token (API Key)
Enabling SSO Login via Auth0