Skip to main content

Proxy endpoint

Create a purpose-built HTTP endpoint that executes an APIEase request and returns its final response to the caller--no custom server needed. Unlike a remote call, a proxy endpoint has its own configured path and method and can be authenticated or unauthenticated.

Endpoint format​

Your proxy endpoint URL looks like:

https://app-admin.apiease.com/api/proxy/<shop-name>/<your-path>
  • <shop-name> identifies your shop.
  • <your-path> is the custom path you choose for this endpoint.

When someone calls this URL using the HTTP method you specify (GET, POST, etc.), APIEase runs the linked request and relays the request’s final response to the caller. This is useful for lightweight APIs, receiving events, or letting external systems start your workflows.

How it works​

  1. The first path segment after /proxy/ identifies your shop.
  2. The remaining path is the custom endpoint path you configure.
  3. APIEase matches the incoming request to your Proxy Endpoint.
  4. APIEase runs the configured request using the incoming data.
  5. The request’s final response is returned to the caller.

Authentication options​

  • Authenticated: The caller supplies an APIEase API key. The shop is already identified by the <shop-name> segment in the proxy URL.
  • Unauthenticated: Anyone who can reach the URL can call it. Treat all incoming values as untrusted and do not return credentials or private data.

Proxy endpoints are intended for external HTTP callers. For code running on the Shopify storefront, use a storefront call through Shopify's app proxy instead.

Configure a proxy endpoint trigger​

  1. Open any APIEase request.
  2. Click the plus icon under Triggers.
  3. Select the Proxy Endpoint radio button.
  4. Set:
    • Request Path: The public endpoint path.
    • HTTP Method: The allowed verb for the endpoint.
    • Authenticated: true or false.
  5. Save. Your public API endpoint is ready to use.