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

# Introduction to Kiosks

> Retrieve menu options for self-service kiosk terminals

Kiosk endpoints allow you to retrieve menu configurations for self-service kiosk terminals. This enables customers to interact with ClearLine marketing features independently at kiosk stations.

## What are Kiosks?

Kiosks are self-service terminals where customers can:

* **Browse Marketing Offers:** View available promotions and coupons
* **Join Loyalty Programs:** Sign up for rewards programs
* **Check Loyalty Balance:** View points, stamps, and rewards status
* **Redeem Offers:** Activate coupons and promotions for their purchase

## How It Works

<Steps>
  <Step title="Kiosk Initializes" icon="power-off">
    Kiosk terminal starts up and authenticates with ClearLine.
  </Step>

  <Step title="Retrieve Menu Options" icon="list">
    Use the [Get Kiosk Menu](/api-reference/kiosks/get-kiosk-menu-list) endpoint
    to load available marketing actions for the terminal.
  </Step>

  <Step title="Display to Customer" icon="display">
    Present menu options on the kiosk screen for customer interaction.
  </Step>

  <Step title="Customer Interacts" icon="hand-pointer">
    Customer selects options and completes actions (join loyalty, view offers,
    etc.).
  </Step>
</Steps>

## Kiosk Endpoints

<CardGroup cols={2}>
  <Card title="Get Kiosk Menu List" icon="list" href="/api-reference/kiosks/get-kiosk-menu-list">
    Retrieve menu configuration for a specific kiosk terminal
  </Card>

  <Card title="Start Interaction" icon="play" href="/api-reference/pos-api-v1/start-pos-interaction">
    Initiate customer session for kiosk interactions
  </Card>
</CardGroup>

## Best Practices

<AccordionGroup>
  <Accordion title="Cache Menu Configuration" icon="database" defaultOpen>
    Cache the menu list and refresh periodically (every 5-10 minutes) rather
    than fetching on every customer interaction to improve performance.
  </Accordion>

  <Accordion title="Handle Offline Gracefully" icon="wifi-slash">
    Implement offline mode with cached menu options. Show a friendly message if
    the kiosk can't reach ClearLine servers.
  </Accordion>

  <Accordion title="Filter by Terminal Configuration" icon="filter">
    The menu endpoint returns options based on terminal configuration. Trust the
    API response to show only relevant features for each kiosk.
  </Accordion>

  <Accordion title="Keep UI Simple" icon="hand-pointer">
    Kiosk users expect quick, intuitive interfaces. Display only essential menu
    items and minimize steps to complete actions.
  </Accordion>
</AccordionGroup>

## Next Steps

<CardGroup cols={2}>
  <Card title="Kiosk Menu API Reference" icon="code" href="/api-reference/kiosks/get-kiosk-menu-list">
    View complete API specification
  </Card>

  <Card title="Authentication Guide" icon="key" href="/api-reference/authentication/introduction">
    Learn how to authenticate kiosk terminals
  </Card>
</CardGroup>