Skip to main content

How It Works

APIEase runs the requests and logic you define. Each request (HTTP, Flow, Liquid, or System) is configured in the APIEase admin and executed inside the APIEase runtime, where confidential parameters remain secure.

This page describes how requests are configured, how they are triggered, and how these elements combine to create custom functionality.

APIEase also includes reusable Functions, persisted Variables, and Widgets. Storefront widgets render in the theme, while Admin widgets provide tools inside Shopify admin. Both are managed in APIEase.

Configuring Requests​

When you create a request, you choose the type (HTTP Request, Flow Request, Liquid Request, or System Request) and define the parameters it needs. These parameters can include:

  • values passed in at trigger time
  • values extracted from earlier requests
  • Liquid based transformations
  • confidential parameters stored securely in APIEase (see Why Secure Parameter Handling Matters)

Each request is saved as a reusable and callable unit of logic.

If you need reusable helper logic inside a Liquid Request, create a Function and call it from Liquid instead of repeating the same template code.

For setup steps, see How to Add Requests.

If you need to manage persisted values outside of a request, use Variables Overview.

Configuring Widgets​

Create widgets from the Widgets Page, then set the shared fields and widget type in the Widgets Edit Page. Follow Edit Storefront Widgets for Liquid and JavaScript, or Edit Admin Widgets for Variables and Shopify component JSX.

Displaying Widgets​

For storefront placement, use the APIEase Widget App Block on a specific page or template, or the APIEase Widget App Embed across the storefront. See Storefront Widgets. For Shopify admin blocks, detail-page actions, and bulk-selection actions, see Admin Widgets.

Triggering Requests​

A configured request can be invoked through several available trigger types. Each trigger activates the same underlying request definition, allowing the logic to run without duplication. Triggers are available in the following order:

Webhooks​

Run a request automatically when Shopify or an external system sends a webhook to APIEase.

Cron Schedule​

Use a built in cron schedule to run a request at recurring intervals.

Proxy Endpoint​

Expose a request as a public API endpoint with an optional shared secret. External systems call the endpoint and APIEase runs the associated request.

Manual Calls​

Invoke any request directly from the APIEase admin for testing or on demand execution.

Storefront calls​

Trigger a request from your storefront using Shopify's app proxy. The storefront sends only non confidential data and APIEase performs the execution on the server side.

Remote Calls​

Send an HTTP call from any external system to APIEase to initiate a request with authentication.

Chained Request​

Run a request from within another request. A request can call additional requests and pass outputs downstream, allowing multi step workflows.

Combining Request Types and Triggers​

Because each request is modular and can be triggered in any of these ways, users can create custom functionality by combining:

  • the request type (HTTP, Flow, Liquid, or System)
  • the trigger source
  • any number of chained steps

This supports use cases ranging from simple API calls to multi step workflows that coordinate data across multiple systems, without building or hosting a backend.