🔗 UltimatePOS Integration Guide

🔗 UltimatePOS Integration Guide #

How to connect your Ultimate Desktop app with UltimatePOS system

💡 If you’re not familiar with code, don’t worry — Ultimate Desktop is built to be easy to set up. Just follow the steps below to activate and link it with your UltimatePOS server.

✅ Prerequisites: #

• You must have access to an UltimatePOS installation (version 5.0 or later is recommended).
• Make sure the Ultimate Desktop Connector module is installed and activated in your UltimatePOS system.
• Your Flutter version must be 3.32.4 or above (stable channel).

🔧 Integration Steps: #

1. Install the Ultimate Desktop Connector Module #

• Log in to your UltimatePOS admin panel.
• Go to Modules → Manage Modules.
• Install and activate the module named Ultimate Desktop Connector.

2. Generate a Client in UltimatePOS #

• After activating the module, go to Desktop Connector → Clients.
• Click on “Add Client”.
• Enter a name for your app (e.g., Ultimate Desktop App).
• Save the client.

3. Copy OAuth Credentials #

• After saving, you’ll get:
  • Client ID (example: 3)
  • Client Secret (example: 4SjAJdkGjAUv0...)
• These will be used to authenticate your desktop app with the POS system.

4. Configure the Desktop App #

• Open the .env file located in the root directory of your Flutter project.

OAUTH_CLIENT_ID=% Paste your Client ID
OAUTH_CLIENT_SECRET=% Paste your Client Secret
OAUTH_BASE_URL=https://your-pos.com

APP_NAME=DevMosaic
APP_VERISON=1.0.0
PURCHASE_CODE=XXXX-XXXX-XXXX-XXXX

✅ Replace the values as follows:

PURCHASE_CODE: The license or activation code for the app (optional if not enforced).

OAUTH_CLIENT_ID: The ID from the client you created

OAUTH_CLIENT_SECRET: The secret key you got after saving the client.

OAUTH_BASE_URL: The base URL of your UltimatePOS instance (e.g., https://your-pos.com)

APP_NAME: The name you want to display for your desktop app.

APP_VERISON: The current version of your app.

Run the Application #

• Once your .env file is configured, build and run the app using:

flutter pub get
flutter run -d windows # or macos/linux depending on your OS

Your desktop app is now authenticated and connected to your UltimatePOS server. You can start using all POS features with enhanced speed and offline capabilities.

Ultimate Desktop — Experience the full power of UltimatePOS, offline, secure, and lightning fast.