WDF ProLink - API Introduction
Overview
WDF ProLink offers robust integration capabilities for third-party POS vendors seeking to enhance Wash Dry Fold (WDF) services by interfacing directly with FasCard and FLEX laundromat systems. Through a comprehensive API, vendors can seamlessly manage WDF orders, track machine usage, and integrate detailed operational insights into their platforms.
Core API Functionalities
1. Creating a New WDF Order
Description: Create a new WDF order linked to a designated Laundry Card.
Required Parameters:
Order Number (Unique identifier for each order)
Optional Parameters:
Weight
Price
UserAccount ID (Identifier linking order to a user)
2. Starting a Machine
Description: Remotely initiate a machine associated with a specific WDF order.
Required Parameters:
Type = 4 (apply balance against WDF order and not user’s balance)
Machine Number (Identifier of the laundry machine)
WDF Order ID (Associated WDF order)
Note: Initiating via API requires manual confirmation at the card reader and possibly the machine.
3. Managing Active WDF Orders
Description: Retrieve and manage details of active WDF orders.
Available Information:
Order Status (Active, Closed)
Assigned Color (Visual identifier on card readers)
Creation Time
Laundry Card Number
Remaining Order Processing Time
Machines Used (Including expected cycle end times and costs)
4. Closing a WDF Order
Description: Mark a WDF order as completed, deactivating associated Laundry Card.
Required Parameter:
Order Number
Additional API Calls
Set Order Processing Time: Adjust allowed time for Laundry Card activation per order (default 45 minutes).
Set Maximum Active WDF Cards: Define concurrent active WDF card limits for operational efficiency.
Get Equipment Types: Retrieve equipment details, including IDs.
Set Machine Operation Cost: Define operational cost per machine cycle.
Get List of WDF Orders: Retrieve detailed lists of WDF orders.
Get List of Available Machines: List all machines with current operational status.
API Credential Management
Credential Generation: Securely obtain credentials through the FasCard/FLEX admin interface.
Credential Limits: Maximum three active credential sets permitted.
Credential Revocation: Credentials can be easily revoked via the admin interface for secure access management.
Card Reader Display Functionality (Coming Soon)
The FasCard and FLEX card readers will feature enhanced visual identification for WDF orders. Each WDF order will display a unique order number and be assigned a distinct color on the card reader's screen, assisting staff in quickly identifying and managing multiple orders simultaneously.
Order Number Display: Prominently visible on card reader screens during the active machine cycle.
Unique Color Assignment: Each order is automatically assigned a distinct color to visually differentiate orders easily.
Compatibility Notice: This feature requires compatible card reader firmware, which is currently under development and will be available soon.
Example Usage
Third-party POS vendors can utilize the WDF ProLink API to enhance operational workflows, for example:
Order Initiation: Upon customer drop-off, the POS immediately creates a WDF order linked to a Laundry Card, streamlining initial processing.
Machine Activation: Employees remotely activate laundry machines directly from the POS, ensuring accuracy and efficient handling of multiple orders simultaneously.
Order Monitoring: The POS continuously updates order status, enabling real-time tracking of machine cycles, remaining processing time, and associated costs.
Order Completion: POS systems automatically mark orders complete, deactivate Laundry Cards, and provide summarized data for billing, inventory management, and customer notification, improving service quality and reducing manual administrative tasks.