Skip to main content
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

Kiosk Initializes

Kiosk terminal starts up and authenticates with ClearLine.

Retrieve Menu Options

Use the Get Kiosk Menu endpoint to load available marketing actions for the terminal.

Display to Customer

Present menu options on the kiosk screen for customer interaction.

Customer Interacts

Customer selects options and completes actions (join loyalty, view offers, etc.).

​
Kiosk Endpoints

Get Kiosk Menu List

Retrieve menu configuration for a specific kiosk terminal

Start Interaction

Initiate customer session for kiosk interactions

​
Best Practices

Cache Menu Configuration

Cache the menu list and refresh periodically (every 5-10 minutes) rather than fetching on every customer interaction to improve performance.
Implement offline mode with cached menu options. Show a friendly message if the kiosk can’t reach ClearLine servers.
The menu endpoint returns options based on terminal configuration. Trust the API response to show only relevant features for each kiosk.
Kiosk users expect quick, intuitive interfaces. Display only essential menu items and minimize steps to complete actions.

​
Next Steps

Kiosk Menu API Reference

View complete API specification

Authentication Guide

Learn how to authenticate kiosk terminals