get https://{shopdomain}.myshoplaza.com/openapi/2022-01/app-proxies/
Requires
read_app_proxyaccess scope.
The App Proxy Details By ID API is used to retrieve detailed information about a specific APP_Proxy instance using its unique identifier.
This API is especially useful for:
- Checking the configuration of an existing app proxy.
- Verifying the
real_pathandproxy_urlmappings. - Auditing or debugging app proxy connections.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | Yes | The ID of the app proxy to query. | 1 |
Response Explanation
Public Response Parameters
Success Response
| Field Name | Type | Description | Example |
|---|---|---|---|
app_proxy.id | int | The unique ID of the app proxy. | 300 |
app_proxy.real_path | string | The URL path to access the app on Shoplazza. | test |
app_proxy.proxy_url | string | The external URL of the developer's application. | http://www.baidu.com/a |
app_proxy.created_at | string | The creation timestamp of the app proxy. | 2022-12-30T09:40:18+08:00 |
app_proxy.updated_at | string | The last updated timestamp of the app proxy. | 2022-12-30T09:40:18+08:00 |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "page not found" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 422 | Unprocessable Entity | empty app proxy id | "strconv.Atoi: parsing "id": invalid syntax" |