Verify the app proxy path
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/back_in_stock/app_proxy/verifyCosts 1 rate-limit point · Rate limits
Check that the storefront answers the app proxy path the store-domain opt-in link uses. valid is true or false; it is null with password_protected true while the storefront password hides the answer.
Read-only: nothing is saved. path_prefix must look like /apps/<suffix> or /a/<suffix>, as set in the app proxy settings in Shopify, or the call fails with 422 invalid_params. Check a path here before saving it as optin.app_proxy_path_prefix in PATCH /back_in_stock/settings/widget: while optin.custom_domain_enabled is on, the double opt-in confirmation link is built from it. A store that doesn't answer within 5 seconds also gives valid: false. If you don't know the path, call GET /back_in_stock/app_proxy/detect.
Also searched asverify app proxycheck app proxy pathtest the app proxy
Query parameters
path_prefixstringRequiredApp proxy path to check, "/apps/<suffix>" or "/a/<suffix>", as set in the Shopify app proxy settings.
Returns
validboolean, nullableExample:truepassword_protectedbooleanExample:true
Errors
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe request failed validation.
Any request can also fail with auth_invalid (401) or rate_limited (429).
Every error has the same shape: see Errors and the list of error codes.
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/app_proxy/verify?path_prefix=string" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/app_proxy/verify?path_prefix=string", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/back_in_stock/app_proxy/verify?path_prefix=string",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/back_in_stock/app_proxy/verify?path_prefix=string")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"valid": true,
"password_protected": true
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}