In-Network

The In-network API is designed for scenarios that need direct, low-latency communication with VELAONE POS solutions within the same local area network. This architecture is ideal for applications that require real-time data exchange and high-performance operations.

Key Features:

  • Ultra-low latency communication
  • Enhanced security through local network isolation
  • Support for high-frequency, real-time operations
  • Direct access to POS hardware resources

We recommend thoroughly analyzing your integration requirements to determine the most suitable API architecture for your specific use case.

Available API Endpoints

The In-Network API provides the following endpoints:

  • Configuration - Retrieve system configuration settings by level and name
  • Menu - Access menu data, products, modifiers, and combos
  • Map - Retrieve restaurant floor plans and table layouts
  • Table - Manage table operations, assignments, and orders
  • Ticket - Access and filter order tickets and receipts
  • Waiting List - Manage customer waiting queue
  • Customer - Store and retrieve customer information
  • Device - Manage device information and settings
  • KDS - Kitchen Display System operations
  • Special Definitions - Common data structures and constants

Connection Method

All API requests are sent as HTTP POST requests to the following endpoint:

Format Example 

POST http://{SERVER-IP}:{SERVER-PORT}/{SERVER-KEY}/action/api

Content-Type: application/json

{JSON-REQUEST-DATA}
            

POST http://127.0.0.1:40009/7062.723823806/action/api

Content-Type: application/json

{
    "requestType": "table",
    "actionType": "getStatusList"
}

Connection Parameters:

  • {SERVER-IP} - IP address of the POS server on the local network
  • {SERVER-PORT} - Server port number (default: 40009)
  • {SERVER-KEY} - Unique server authentication key

Request Format:

All requests must be JSON-encoded objects containing at minimum:

  • requestType - The API endpoint to call (e.g., "table", "ticket", "menu")
  • actionType - The specific action to perform (e.g., "getList", "save")

Response Format:

All responses are JSON-encoded objects containing:

  • status - Request status ("OK" or "ERROR")
  • Additional fields specific to the endpoint and action