Documentation

Getting Started (beta)

The MidwayPlus app store is currently in a closed beta. If you'd like to make apps for MidwayPlus please inquire at info@midwayplus.com.

Types of Apps

API-Driven Apps (External Apps)

Description:
API-Driven Apps integrate seamlessly with our eCommerce marketplace using our robust set of RESTful APIs. These apps are designed to enhance the experience of buyers and sellers by leveraging marketplace data and functionality without directly altering real-time operations. With these apps, you can build tools like analytics dashboards, inventory management systems, or personalized recommendation engines—all powered by secure, programmatic access to marketplace data such as orders, products, customers, and user profiles. Interaction is entirely handled through API calls, ensuring that real-time transaction flows and core platform behavior remain unaffected. Perfect for developers looking to create value-added services that operate alongside the marketplace.

Key Features

  • Access to marketplace data (e.g., orders, products, user details) via APIs.
  • No impact on real-time transaction or operational logic.
  • Ideal for reporting, automation, or external integrations.

How It Works:
After authenticating with your developer credentials, you can generate authentication tokens from your app installations. With the authentication tokens, you can begin making API requests to retrieve or update data to delivery functionality through your own UI or backend.

Realtime Apps

Description:
Realtime Apps take marketplace integration to the next level by injecting custom logic and data directly into the buyer and seller experience, with the ability to influence behavior as it happens. These apps are perfect for scenarios requiring immediate, dynamic enhancements—like customizing checkout flows, injecting real-time pricing rules, or adding live notifications. Leveraging webhooks (and potentially other mechanisms as we evolve), these apps receive instant updates from the marketplace and can respond by injecting logic or data back into the platform. This type is suited for developers who want to create deeply integrated, responsive tools that shape the marketplace in real time.