> ## Documentation Index
> Fetch the complete documentation index at: https://developers.perkstar.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Perkstar developer platform

> Connect POS, CRM, commerce, and back-office systems to Perkstar loyalty.

Build loyalty into the systems a business already uses. The Perkstar API lets an
integration find or create customers, enrol them onto cards, add stamps or
points, reverse mistakes, send wallet pushes, and receive signed webhooks.

<CardGroup cols={2}>
  <Card title="Make your first request" icon="rocket" href="/quickstart">
    Create a key, confirm the connection, and inspect your first response.
  </Card>

  <Card title="Build a POS integration" icon="credit-card" href="/guides/pos">
    Scan a wallet pass, credit loyalty, and reverse a refunded sale safely.
  </Card>

  <Card title="Connect Odoo" icon="boxes-stacked" href="/guides/odoo">
    Map customers and orders without duplicating records or rewards.
  </Card>

  <Card title="Explore the API" icon="brackets-curly" href="/api-reference">
    Use the generated reference, request builder, and response schemas.
  </Card>
</CardGroup>

## Designed for production

* **Scoped access.** Each key can do only the jobs you select.
* **Safe retries.** Idempotency keys prevent a timeout from becoming a double stamp.
* **Permanent POS deduplication.** Stable transaction references remain unique beyond the 24-hour request cache.
* **Signed webhooks.** Verify every delivery before trusting its contents.
* **Request tracing.** Every response includes an `X-Request-Id` that Perkstar support can trace.

<Note>
  API access is available to eligible Perkstar plans. Create and manage keys in
  **Dashboard → Settings → API keys**. A secret is shown once, so store it in a
  server-side secret manager when it is created.
</Note>

## Choose a starting point

| You are building                       | Start here                             |
| -------------------------------------- | -------------------------------------- |
| A POS or till plugin                   | [POS integration](/guides/pos)         |
| An Odoo connector                      | [Odoo integration](/guides/odoo)       |
| A CRM or customer import               | [Customer sync](/guides/customer-sync) |
| A server that reacts to loyalty events | [Webhooks](/guides/webhooks)           |
| A TypeScript or Node.js service        | [TypeScript SDK](/sdks/typescript)     |


## Related topics

- [Changelog](/changelog.md)
- [Send push notifications](/guides/wallet-pushes.md)
- [Connect Odoo](/guides/odoo.md)
- [Go-live checklist](/support/go-live-checklist.md)
- [Synchronise customers](/guides/customer-sync.md)