Usage examples

Practical scenarios showing how uAPI works on a live site interface

uAPI usage examples

This page collects practical scenarios where the API speeds up everyday site tasks: talking to visitors, navigating content, and updating user profiles.

💬

Quick comment replies

Lets visitors comment on a post without opening the material page. Useful as a reactions-style interaction.

 🔎

Live site-wide search

Dynamic search shows matching results as the user types and helps them reach the right content faster.

 ✏️

User nickname change

A profile-page UI updates the display name without admin involvement and without a complex settings form — in a few clicks.

 📣

Telegram-to-blog autoposting

A VPS service watches new posts in a Telegram channel and automatically publishes them to the Blog module via UAPI.

Server script examples

Server scripts move complex data processing to the server and connect it with website modules. See the Server scripts page for available runtimes and tools.

🛍️

Smart filters for online stores

This multi-filter adds faceted catalogue filtering by category, brand, price, product attributes, availability, and discounts.

 📊

Order statistics dashboard

A Node.js application retrieves store data through uAPI and displays revenue, order statuses, products, and key metrics.
Scenario 01

Quick comments

Visitors can leave quick comments directly from the publication feed without reloading the page or opening the full material page.

⬇ Download example archive

Setup instructions are inside the example archive.

Comment list for quick reply
Comment reply form
Quick reply sent successfully
Scenario 02

Live site-wide search

Search queries site data on the fly and shows suggestions while the user types. This reduces dead-end navigation and helps visitors reach the right section, article, or product card faster.

⬇ Download example archive

Setup instructions are inside the example archive.

Live search field on the site
The user starts typing a query while the interface prepares results without reloading the page.
Live search suggestions
Intermediate results appear right under the search box and help refine what the visitor is looking for.
Live search results across the site
The final list works as an entry point into site-wide navigation.
Scenario 03

Change user nickname on profile page

The profile page can show a dedicated button that opens a uAPI-powered UI and applies the new name immediately. This makes account settings clear for end users.

⬇ Download example archive

Setup instructions are inside the example archive.

Nickname change form on profile page
The edit form is embedded in the profile and feels like a natural part of the account area.
Nickname change confirmation
After a successful update, the user sees the result right away and knows the change was applied.
Scenario 04

Autopost from Telegram channel to Blog module

A Telegram bot watches new posts in the official @UcozNews channel; a VPS service receives events and uses UAPI to publish entries to the official Ucoz blog. The site then automatically creates Blog module posts with the same title and body as in the channel.

⬇ Download example archive

Setup instructions are inside the example archive.

Telegram-to-blog autopost interface
The VPS service receives new channel posts from Telegram and prepares a record for UAPI.
Post published from Telegram in Blog module
After processing, the material appears in the Blog module with the same title and content as the original channel post.
Scenario 05

Online store order statistics dashboard

This ready-to-use Node.js application retrieves Online Store module data through uAPI and presents it in a protected analytics dashboard. It shows revenue, order counts and statuses, average order value, units sold, product inventory, and recent activity for a selected period.

Technologies: Node.js 18+ and uAPI with Bearer Token authentication. The application is read-only: it does not create, update, or delete products or orders.

⬇ Download example archive

Step-by-step installation instructions are included in the archive as INSTALL.md.

Dashboard overview with revenue, orders, and order status funnel
Summary metrics, revenue trends, and order distribution by status for the selected period.
Product sales and inventory statistics table
Product ranking with units sold, order counts, revenue, and current inventory.
Recent online store orders table
Recent orders with dates, statuses, item counts, and totals.
Scenario 06

Smart filters for online stores

This ready-to-use PHP multi-script for uCoz server scripts adds faceted filters to catalogue pages. Visitors can filter products by category, brand, price, product attributes, availability, and discounts. Results update without reloading the page, and the selected parameters remain in the URL.

Configuration is handled through the built-in dashboard: select the product grid container, import the product card template, and adjust the filter appearance without editing the site code.

⬇ Download example archive

Step-by-step installation instructions are included in the archive as INSTALL.md.

Faceted filters on an online store catalogue page
Filters by price, brand, packaging, availability, and discounts update the results without reloading the page.
Mobile online store filters panel
On mobile devices, the filters open in a separate slide-out panel.
Smart filters management dashboard
Use the dashboard to select the catalogue container, import the product card template, and customize the widget appearance.