Request Parameters Overview
APIEase lets you pass data into requests in several ways so each run has the inputs it needs without exposing sensitive values.
- In-app parameters: Saved values configured on the request. Use these when the value rarely changes or when a sensitive request parameter must remain server-side.
- Dynamic embedded parameters: Values provided at runtime by a caller, such as storefront code, a widget, or another request. They can supply headers, query values, path values, a body, Flow values, or Liquid values for one execution.
- Path variables: Placeholders in the request URL (
/products/{id}) that are filled by in-app or dynamic embedded parameters when the request executes. - Chained request parameters: Data passed from the response of one request into the next request in a sequence.
Choose the parameter type based on where the value comes from and whether it must stay confidential. Combine these options to keep sensitive data secure while still letting each trigger supply the context it needs.
Choose the parameter location from the receiving API's contract:
- Headers carry request metadata, content type, or authentication.
- Query parameters become key-value pairs in the URL query string.
- Path parameters replace named path variables in the address.
- Body carries the request payload. Use form URL-encoded bodies only when the receiving API requires that content type.
For Liquid requests, distinguish saved Liquid parameters from runtime embedded Liquid parameters:
- Saved Liquid parameters are configured on the request and can be substituted with
{parameterName}before execution. Use saved Liquid parameters for stored defaults, sensitive values, or other server-side configured values. - Runtime embedded Liquid parameters are supplied by a caller with
liquidParamsEmbeddedand are read in Liquid throughapiEaseParameters.liquidParams.<parameterName>. UseliquidParamsEmbeddedfor per-call values supplied at runtime.
See In-app parameters vs dynamic embedded parameters for the saved-versus-runtime decision and override behavior. For quick request-building answers, see the Building requests FAQ.