Skip to content

Module API#

The Miva Merchant Module API is a crucial aspect for developers aiming to create custom modules or apps within the Miva Merchant platform. Let’s delve into what the Module API entails and how it facilitates module development:

Overview#

  • Definition:

    • The Module API enables the creation of custom modules for Miva Merchant.
    • A module is essentially a compiled MivaScript file containing specific functions required by Miva Merchant.

  • Module Features:

    • Modules implement various features, which are groups of functions recognized by Miva Merchant.
    • These features allow modules to integrate seamlessly with Miva Merchant’s existing functionality or extend it.

Understanding Features#

  • Feature Implementation:

    • Modules can implement one or multiple features, depending on the desired functionality.
    • Each feature comprises a set of functions that must be present in the module for proper operation.

  • Importance of Functionality:

    • Missing functions for a feature can lead to installation errors or runtime issues within Miva Merchant.

Leveraging API Reference Guide#

  • Module Description Function:

    • Every module must include the Module Description Function, defining its features.
    • The API Reference Guide assists developers in understanding feature implementation and function requirements.

  • Function Lookup:

    • Developers can search for specific features and functions within the API Reference Guide for detailed information.

Utilizing Limited Source Kit (LSK)#

  • LSK Usage:
    • The Limited Source Kit contains example modules and resources for module development.
    • Developers can leverage the LSK to explore sample code and implement necessary features.

Exploring Installed Modules#

  • Module Management:
    • Within the Miva Merchant Admin, developers can view installed modules and their associated features.
    • This provides insights into the functionality available and helps determine required features for new modules.

Conclusion#

The Miva Merchant Module API offers developers extensive flexibility and control over module development. By understanding features, implementing necessary functions, and leveraging available resources like the API Reference Guide and the Limited Source Kit, developers can create powerful and customized modules tailored to their specific needs. The Module API serves as a cornerstone for extending Miva Merchant’s functionality and enhancing its capabilities.