Skip to main content

Myop Cloud APIs

Overview​

Myop Cloud provides APIs to retrieve the latest component configurations for your applications in real time. These configurations are essential for rendering and managing components dynamically based on user flows.

Before you can fetch a component configuration, you need to ensure that:

  1. The component is added to a User Flow in the Myop Dashboard.
  2. The User Flow has been Published to make the latest changes available. (Publishing Guide)

Once these steps are completed, you can use the FLOW_ID to fetch the latest configuration in real time.

Fetching Component Configurations​

To retrieve the latest component configuration for a given User Flow, make the following API request:

API Endpoint​

GET https://cloud.myop.dev/flow?id=${FLOW_ID}&resolve=components

Parameters​

  • FLOW_ID – The unique identifier for your User Flow. You can find this in the browser's URL when viewing the flow in the Myop Dashboard.
  • resolve=components – Ensures that the response includes the full component configuration.

Response​

The API returns an object of type IUserFlow, which contains details about the user flow and its associated components.

Purpose of Myop Cloud​

Myop Cloud is designed to provide a centralized and scalable way to manage UI components dynamically. It enables:

  • Real-time updates: Ensure that your application always uses the latest published component configurations.
  • Decoupled component management: Define components in the Myop Dashboard and retrieve them as needed without hardcoding configurations in your frontend.
  • Micro frontend integration: Myop Cloud makes it easier to load and manage remote UI components across different applications, improving flexibility in micro frontend architectures.

More APIs will be added to Myop Cloud soon, expanding its capabilities to support additional features and integrations. Stay tuned for updates!