UChat Official

Introduction


In the evolving landscape of chatbot development, creating mini apps offers a powerful way to enhance functionality, user experience, and integration capabilities.

This guide explores how to build, customize, and deploy mini apps—both JSON-based and flow-based—within a chatbot platform, emphasizing their features, setup processes, and benefits.

Building Mini Apps – An Overview

Mini apps serve as customized, native-like interfaces that extend chatbot capabilities. They enable developers to connect external platforms via API calls, streamline user interactions, and embed complex functionalities seamlessly.

Types of Mini Apps

Version

Description

Features

Status

Mini App v1

JSON-based

Simple API integrations, static data

Fully available

Mini App v2

Flow-based (Beta)

Visual flow builder, dynamic data, advanced features

In beta

Key Steps to Create a Mini App:

  • Access the Platform: Click the blue button at the top right to initiate app creation.

  • Choose App Type: Select either Mini App v1 or Mini App v2.

  • Name & Create: Enter a name, then click Create.

  • Draft Overview: The app appears in your overview, with options to publish or edit.

Customizing and Editing Your Mini App

Basic Details

On the left panel, you can specify:

  • Title

  • Description

  • Logo & Cover Image

  • Tutorial Video (YouTube ID)

Authentication & Sample Data

  • Authentication Tab: Set API keys, headers, and tokens.

  • Sample Data: Pre-fill API requests for testing, such as product info or user data, by clicking Sample Data buttons.

  • API Calls & Triggers: Define actions like GET, POST, or custom API requests, including headers, payloads, and data mappings aligned with your API documentation.

Sources & API Scopes

  • Sources: Add static or dynamic data sources.

  • API Scopes: Select necessary permissions for your app.

  • API Token Requests: Configure token retrieval requests for secure access.

Finalizing & Publishing

Once configured, click Save. You can publish the app or continue editing drafts.

Flow-Based Mini Apps (Version 2)

Flow-based mini apps provide a visual environment similar to chatbot flow builders:

  • App Fields: Pre-build fields like text, number, boolean, date, json.

  • Authentication: Set up via API key or other methods.

  • Actions & Triggers: Create new actions, similar to version 1, with a drag-and-drop interface.

  • One-Time URLs: Generate URLs for specific mini app functions.

  • Sources & Settings: Manage data sources and app metadata.

This version emphasizes dynamic interactions and more complex workflows, making it suitable for sophisticated integrations.

Summary of Key Features

  • Mini App v1: JSON-based, straightforward API integration.

  • Mini App v2: Flow-based, visual builder, advanced features.

  • Customization: Titles, descriptions, logos, tutorials.

  • Authentication & Security: API keys, tokens, scopes.

  • Data Management: Static/dynamic sources, sample data.

  • Deployment: Drafts, publishing, ongoing editing.