Integrations
Integrations are for teams building technical connections with Loyal Guru. They cover the implementation guides needed to connect an external system — POS, e-commerce checkout, mobile app, kiosk, middleware, or embedded loyalty frontend — to Loyal Guru.
These docs assume you already understand what Loyal Guru does (see Product Docs). The focus here is on how to connect by module and use case. Endpoint schemas, authentication headers, rate limits, and low-level HTTP behavior live in the live API Reference.
Public documentation spaces
| Section | Use it for |
|---|---|
| Product Docs | Product behavior, configuration, use cases, and operator guidance. |
| Integration guides | Step-by-step implementation flows for POS, e-commerce, app, kiosk, and middleware integrations. |
| API Reference | Live endpoint catalog (OpenAPI / Redoc) — updates with the Streaming API. |
Quick links:
Who this is for
| Role | How to use these docs |
|---|---|
| Integration developer | Primary audience — step-by-step guides to connect each module |
| Technical architect | Overview of the integration model, data flows, and authentication |
| QA / test engineer | Request/response reference for test case design |
| Project manager | Scope and module map to estimate integration effort |
Integration overview
Loyal Guru integrations follow the same sequence most projects use: first connect Data (Company master data and Customer identity), then evaluate loyalty and promotion mechanics, then add gamified experiences, and finally embed WL App SDK modules when the channel needs a ready-made loyalty frontend.
For endpoint-level details, use the live API Reference. For implementation decisions and flow design, use the module guides below.
Configuration (creating campaigns, building audiences, setting up rewards) is done through the Owner App or the Management API. The runtime integration is the loop where your system sends the current cart/session state, Loyal Guru evaluates it, and your system applies the returned effects.
Integration modules
| Module | What to integrate | Guide |
|---|---|---|
| Quickstart | First runtime request: send a cart, read effects, and apply the result | Open guide |
| Integration Checklist | Scope, identity, master data, runtime, testing, webhooks, and launch readiness | Open guide |
| Integration Tutorial | End-to-end example from setup data to cart confirmation and optional webhooks | Open guide |
| Initial Setup | Environments and Streaming API keys (X-Api-Key, X-Api-Secret) | Open guide |
| Data | Company Data (products, stores, taxonomies) and Customer Data (identity scenarios, get, create, merge, cards) | Open guide |
| Loyalty and Promotional Engine | New Engine Promo Engine, New Engine Coupon Server, Legacy Coupon Server | Open guide |
| Gamified Campaigns | Games, challenge progress bars, dates, freshness, prizes, and awards | Open guide |
| WL App SDK | Embed loyalty modules in a web, e-commerce, kiosk, or hybrid app experience | Open guide |
| Webhooks | Outbound events, connector setup, JWT authentication, logs, and troubleshooting | Open guide |
| API Reference | Authentication, HTTP behavior, rate limits, errors, idempotency, and endpoint catalog | Open live reference |
Endpoint reference
For authentication headers, HTTP behavior, and the full endpoint list, see the live API Reference.
Integration scope — discounts
Before starting a discount integration, confirm the integration scope with the Loyal Guru team:
| Scope | apply_discounts | What your system receives |
|---|---|---|
| LG calculates | true | Calculated discount effects and final values in the cart response — apply directly |
| You calculate | false | Applicable rules, coupon/voucher validation, and campaign data — your system calculates the amounts |
The scope is set per company at the configuration level and can be overridden per transaction.