qiibee Documentation
HomepageDashboardGet in touch
  • Welcome to qiibee
  • Introduction
    • qiibee Ecosystem
    • Product Components
    • Sample Use Case
      • Rewards Marketplace
      • Non-Fungible Tokens (NFTs)
      • Merchant App
      • Miles & More
    • Four Steps to Success
      • Step 1: Create Point
      • Step 2: Plan and Design
      • Step 3b: Start Integration (Loyalty API)
      • Step 3a: Start Integration (Loyalty Whitelabel App)
      • Step 3c: Start Integration (Your API)
      • Step 4: Launch to End-Users!
    • Customer Success Roadmap
  • Integrations
    • Integration Options Overview
    • Light vs. Full Integration
    • Loyalty API
    • Loyalty Whitelabel App (LWA)
    • Your API
    • Extensions
      • Woocommerce
      • Shopify
  • qiibee Loyalty API
    • Introduction
    • Users API
    • Points Exchange API
    • Points Bank API
    • Points Engine API
    • Exchange Options
    • Webhooks
  • FAQ & Feedback
Powered by GitBook
On this page
  • Base URL
  • Authentication
  • Sandbox
  • Postman Collection

Was this helpful?

  1. qiibee Loyalty API

Introduction

qiibee API Documentation

PreviousShopifyNextUsers API

Last updated 1 year ago

Was this helpful?

The Loyalty API uses conventional HTTP response codes to indicate the success or failure of an API request.

In general, the 2xx range indicates success, the 4xx range indicates an error due to bad data or an authentication failure. And the 5xx range indicates an error with qiibee's servers (these are rare).

Base URL

The Base URL for all API requests is https://bwaapi.qiibee.com/api/admin

Authentication

All API endpoints are authenticated with the X-API-KEY header.

If you do not send the header, or the header is invalid we will return a 401 with an error message Missing x-api-key header or Invalid API Key.

You can create your API key at the in the section.

Sandbox

The sandbox environment implements the behaviour of the actual API but in a test environment so you can test out your flows before calling the real API.

The base URL for all sandbox APIs is https://bwaapi-sandbox.qiibee.com/api/admin

The API key must be created on the in the section.

Postman Collection

You can use this Postman collection to test all endpoints. Ensure to set the environment variables in the collection so that the API behaves as intended.

qiibee Loyalty Admin Dashboard
Integration
qiibee Loyalty Admin Dashboard Sandbox
Integration
23KB
qiibee Loyalty API.postman_collection.json