> ## Documentation Index
> Fetch the complete documentation index at: https://help.lobyco.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting started with Lobyco

> What the Lobyco platform consists of, and the three points in a purchase where your POS talks to it.

Lobyco is a modular loyalty platform, run as a service. It gives you a white-label mobile app, the Lobyco Admin Portal and the APIs behind both. You build the loyalty programme on top and connect it to your POS and your other systems. This page says what the pieces are, where the integrations sit, and how the API reference is organised.

<img src="https://mintcdn.com/lobyco-4c9fb3ad/fN3x30V3MgkKoZMx/images/get-started-01-platform-overview.png?fit=max&auto=format&n=fN3x30V3MgkKoZMx&q=85&s=4004cb19943d29985c79525a5edc2993" alt="The Lobyco platform: customers use the white-label app, marketers the admin portal and customer support the analytics; an integration layer connects the Lobyco services to the client's POS, services and database" width="882" height="395" data-path="images/get-started-01-platform-overview.png" />

*Each client has its own tenant. Customers, marketers and support staff reach it through the app, the admin portal and reporting; your own infrastructure connects through the integration layer*

## How it works

Each client runs on its own tenant, with its own application instances and databases. Lobyco operates all of it. Nothing is installed or maintained on your side; your part of the work is the integration.

| Component | What it is | Who uses it |
| - | - | - |
| White-label mobile app | The iOS and Android app, branded for you | Customers |
| Lobyco Admin Portal | Where campaigns, offers, content and customers are managed | Marketers and customer support |
| Backend services | The services behind the app and the portal, open to your systems through REST APIs | Your POS, website and backend |
| Integration layer | Optional. Connectors Lobyco builds between its services and your ERP, PIM, POS or database | Your infrastructure |
| Data platform | Curated datasets for reporting and analysis | Your analysts |

## Where a purchase meets Lobyco

A loyalty programme only works when Lobyco sees what happens at the till. That is either a live connection from your POS to the Lobyco APIs, or data the POS produces, sent afterwards. You can build against the REST APIs yourself, or Lobyco can build an integration layer between your systems and its services.

A purchase meets Lobyco at three points, shown below. Each is optional, and each can be done in more than one way. Together they run the loyalty programme end to end. That is enrolment, identification at the POS, coupon and reward redemption, and purchase processing, so that points and rewards accumulate.

<img src="https://mintcdn.com/lobyco-4c9fb3ad/fN3x30V3MgkKoZMx/images/get-started-02-purchase-stages.png?fit=max&auto=format&n=fN3x30V3MgkKoZMx&q=85&s=1890806612ae174ca2ccc9a5da18256b" alt="The three stages of a purchase: Identify, where the app and the check-in service link the customer to the sale; Verify, where the POS calls the promotion services; and Settle, where the purchase is loaded and feeds bonus calculation, ongoing campaigns and digital receipts" width="885" height="367" data-path="images/get-started-02-purchase-stages.png" />

*Identify, verify, settle: the customer is linked to the sale, the offers are applied, and the finished sale is loaded*

### Identify

The customer checks in at the POS with their preferred method: the app's QR code, a membership card, or another identifier. That links the transaction to a customer in the [Members](/api-reference/loyalty-and-membership/members) API. It can happen at any point in the transaction, depending on the flow you implement.

### Verify

The POS asks Lobyco which offers apply. There are two ways. The POS fetches the customer's active coupons with [GET /v2/customers/\{customerId}/coupons](/api-reference/promotion-platform/coupons-pos/get-v2-customers-customerid-coupons) and applies them itself. Or the POS sends the basket to the [Discounts](/api-reference/promotion-platform/discounts) API, and Lobyco returns the offers that apply and the discounts it calculated.

### Settle

The POS, or your e-commerce platform, sends the finished sale to the [Purchases](/api-reference/retail-master-data/purchases) API. Lobyco then processes it for every scenario you use:

* Calculating bonus cash or points, and adding them to or deducting them from the customer's account.
* Progressing ongoing campaigns, such as challenges and stamp cards.
* Rendering the digital receipt, shown in a web frame in the app or in other channels.

## Environments

When you sign a contract, Lobyco gives you a test environment and a production environment. Each has its own APIs, admin portal and app builds. What an environment offers differs per client, because Lobyco releases new versions continuously and tailors functionality per contract. Treat this documentation as the overview, and your own environment as the truth.

## API categories

The API reference groups endpoints by who calls them:

| Category | Who calls it | Available to you |
| - | - | - |
| Service-to-service and web | Your backend, POS and website | Yes, out of the box |
| Mobile app | The Lobyco mobile app | On request, where not already exposed |
| Admin tool | The Lobyco Admin Portal | On request, where not already exposed |

## API reference

Endpoint documentation: [Members](/api-reference/loyalty-and-membership/members), [Coupons (POS)](/api-reference/promotion-platform/coupons-pos), [Discounts](/api-reference/promotion-platform/discounts) and [Purchases](/api-reference/retail-master-data/purchases).

## Related

* [POS (point of sale) integrations](/integration/pos-point-of-sale-integrations) — the check-in, coupon, discount and payment flows at the till.
* [Transaction data](/integration/pos-point-of-sale-integrations/transaction-data) — what the settle call carries, and why it is the one that records the sale.
* [API authentication](/integration/get-started/api-authentication) — how your systems get a token for these APIs.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.