Quroosh Developers
العربية

Quroosh Partner API

The Partner API is the server-to-server surface for integrations with the Quroosh loyalty platform. POS systems, ERPs, and loyalty aggregators use it to issue points and stamps, redeem rewards, and receive real-time webhook events about customer activity.

Base URLs

Staging: https://api-staging.quroosh.io/api/partner/v1
Production: https://api.quroosh.io/api/partner/v1

What you get

  • REST + JSON — every endpoint accepts and returns JSON, standard HTTP status codes, and a consistent error envelope.
  • API key + HMAC signing — the event ingest POST carries an X-Api-Key and an X-Signature header signed with your webhook secret; GET reads need only the API key.
  • Safe retries — the event endpoint deduplicates on the eventId in the body, so a resent event never double-counts.
  • Webhooks — loyalty rule changes and integration-status changes are delivered to your endpoint with the same HMAC scheme (more events coming).
  • Staging environment — full API surface against test data with test API keys.
Availability

The API is rolling out in stages. Each endpoint, event, and mechanism in these docs is tagged Availableor Planned so you always know what works today versus what to build against for later.

Where to start

  1. Quickstart — the full integration path: credentials, connection test, branch mapping, and your first sale event.
  2. Authentication — API key issuance, headers, HMAC signing.
  3. Customer lookup — read a customer's balance, tier, and redeemable rewards at checkout.
  4. Event types — the full event catalogue and payload shapes.
  5. Webhooks — signature verification, retries, event catalog.
  6. API Reference — full endpoint list, request/response schemas, try-it playground.

Support

Partner integration support: support@quroosh.io. Include your partner name and, if a request is failing, the X-Correlation-Idheader value from the response — we use it to trace one call end-to-end through our logs.