Skip to main content

Developer tools and automation FAQ

Should I use the APIEase admin, Apex, the CLI, the template, or the public API?​

Use the APIEase admin for interactive configuration and testing. Use Apex for conversational changes to requests and widgets inside APIEase. For source-controlled work, start with apiease-template and use apiease-cli to sync saved resources. Use the public API directly for custom HTTP automation that the CLI does not cover.

A coding agent working in a template repository is a separate workflow from Apex. See the developer overview for the complete comparison.

Is the APIEase public API an arbitrary outbound API proxy?​

No. The APIEase public API manages saved request, widget, Variable, and Function resources, and it can execute an existing saved request remotely. Create the saved resource first; you cannot send the remote caller an arbitrary destination URL and use APIEase as a one-off proxy. See the public API contract.

How do I authenticate to the APIEase public API?​

Send your APIEase API key in x-apiease-api-key and the target shop domain in x-shop-myshopify-domain. This key authenticates calls into APIEase; it is not a Shopify access token or an external provider credential. Learn how the key is stored and rotated on the APIEase API Key page.

How do I run a saved request from another system?​

Send a request to /api/remote/caller/call?requestId={request-handle} with the APIEase authentication headers. Although the query parameter is named requestId, use the saved request's handle as its value for new integrations. Follow Calling APIEase Requests Remotely for the complete example and parameter behavior.

What is a resource handle, and should I store an id in git?​

A handle is the stable, user-controlled public identifier for a saved request, widget, Variable, or Function. Use it in source files, CLI commands, and public API item routes. Do not store server-owned id values in repository resource definitions. See Resource handles for formats, legacy aliases, and execution surfaces that still call the value requestId.

How do I keep APIEase resources in source control?​

Initialize a repository with apiease init, store request, widget, Variable, and Function definitions under the directories configured by apiease.config.js, and commit those files to git. Use the template quickstart for setup and the apiease-template reference for file ownership and upgrade behavior.

Does apiease create create duplicates when I rerun it?​

Not when a request, widget, Variable, or Function file has a valid handle. apiease create <resource> --file <path> reads the remote resource by handle, updates it when found, and creates it when missing. Lookup failures other than not found stop the command. See apiease-cli for supported resources, flags, and migration options.

Can an AI agent manage APIEase resources for me?​

Yes, but choose the workflow deliberately. Apex can create, update, and delete requests and widgets directly inside APIEase. A coding agent in an apiease-template repository can manage requests, widgets, Variables, and Functions as files and sync them with apiease-cli, with git diffs providing a review boundary. Follow Using APIEase with AI agents.

Does Apex preview or wait for approval before changing a resource?​

No. Apex applies request and widget creation, updates, and deletions during the conversation without a general preview, approval, undo, or safe-mode layer. Review created or updated resources afterward and be careful with deletion instructions.

Request execution safety is narrower: Apex may initially use an integration-specific dry-run setting or disabled ALLOW_* Variable where appropriate. Inspect and test the request before enabling live behavior. See Using APIEase with AI agents for this distinction.