CloudBlue Commerce API

Last updated 15-Jan-2021
  • API Overview
  • Using Platform Services
  • Integrating Cloud Services
  • Concepts
  • API Reference
    • APS Types
    • REST Interface
    • User Interface
      • Navigation
        • Navigation Tree
        • Data Exchange
        • APSC Methods
        • Application Methods
      • View Structure
      • JS Modules
      • Polyfills
    • PHP Framework
    • Package Structure
  • Tools and Downloads
  • Glossary
  • What’s New

Previous topic

User Interface

Next topic

Navigation Tree

Navigation¶

Navigation API is a part of the APS JS API. It allows the platform user panel (supported by the APS controller - APSC) and applications (APP) to interact with each other on the presentation level.

The navigation API allows for the exchange of data and calling methods declared on both sides. The API is split into the following namespaces:

  • aps.context is a set of parameters and structures that the user panel uses to transfer data to application views plugged into the panel.

  • aps.apsc is a set of predefined APSC methods that application UI code can call.

  • aps.app declares a set of application methods that application UI code can define. Respectively, the user panel can call them to maintain the predefined workflows and process events triggered in the user panel or through the user panel.

The last two namespaces are presented in the following diagram for the case when the UX1 with the single-page technology is used.

../../../_images/navigation-api.png

The diagram illustrates only typical structure, method definitions, and calls. For more details, refer to the following documents:

  • Application view structure in the user panel

  • Application view structure in UX1

  • Data Exchange

  • APSC Methods

  • Application Methods

← User Interface
Navigation Tree →
© 2020 Ingram Micro, Inc. All Rights Reserved. Privacy Policy Terms of Use Platform Services About CloudBlue Support Contacts