Detect 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/detectCosts 1 rate-limit point · Rate limits
Find which app proxy path the storefront answers, from the paths STOQ installs with. detected is that path, or null when none answers (or the storefront password hides it).
Read-only: it tries each candidate path on the shop's myshopify.com storefront and saves nothing. To use the path it finds, send it as optin.app_proxy_path_prefix in PATCH /back_in_stock/settings/widget. A storefront password page or a store that doesn't answer also gives detected: null, so null does not prove the proxy is missing. To test a path of your own, call GET /back_in_stock/app_proxy/verify. Each try waits up to 5 seconds.
Also searched asdetect app proxyfind app proxy path
Returns
detectedstring, nullableExample:string
Errors
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/detect" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/back_in_stock/app_proxy/detect", {
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/detect",
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/detect")
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){
"detected": "string"
}{
"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
}
]
}