PWAs

检索所有

GET https://pushye.com/api/pwas/
curl --request GET \
--url 'https://pushye.com/api/pwas/' \
--header 'Authorization: Bearer {api_key}' \
参数 细节 描述
search 可选的 字符串 搜索字符串。
search_by 可选的 字符串 您正在按哪个字段搜索。允许的值为：name。
datetime_field 可选的 字符串 允许的值：datetime, last_datetime
datetime_start 可选的 字符串 Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end 可选的 字符串 Filter results up to this datetime. Y-m-d H:i:s format.
order_by 可选的 字符串 按哪个字段排序结果。允许的值有：pwa_id, name, datetime, last_datetime。
order_type 可选的 字符串 结果的排序。允许的值为：ASC 表示升序排序，DESC 表示降序排序。
page 可选的 整数 您想要结果的页码。默认为 1。
results_per_page 可选的 整数 每页您想要多少个结果。允许的值是：10, 25, 50, 100, 250, 500, 1000。默认为25。 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "name": "Example app",
            "settings": {
                "short_name": "Example",
                "description": "Example PWA application.",
                "start_url": "https://example.com/",
                "display": "standalone",
                "orientation": "any",
                "background_color": "#ffffff",
                "theme_color": "#237fff",
                "app_icon_url": "https://example.com/icon.png",
                "app_icon_maskable_url": "",
                "mobile_screenshot_urls": ["", "", "", "", "", ""],
                "desktop_screenshot_urls": ["", "", "", "", "", ""],
                "shortcuts": [
                    {"name": "", "description": "", "url": "", "icon_url": ""},
                    {"name": "", "description": "", "url": "", "icon_url": ""},
                    {"name": "", "description": "", "url": "", "icon_url": ""}
                ],
                "id": "",
                "dir": "auto",
                "lang": "en",
                "scope_url": "https://example.com/"
            },
            "manifest": {
                "name": "Example app",
                "short_name": "Example",
                "description": "Example PWA application.",
                "start_url": "https://example.com/",
                "display": "standalone",
                "orientation": "any",
                "background_color": "#ffffff",
                "theme_color": "#237fff",
                "lang": "en",
                "dir": "auto",
                "scope_url": "https://example.com/",
                "icons": [
                    {
                        "src": "https://example.com/icon.png",
                        "type": "image/png",
                        "purpose": "any",
                        "sizes": "512x512"
                    }
                ]
            },
            "last_datetime": null,
            "datetime": "2026-07-28 00:29:07"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total_results": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://pushye.com/api/pwas?page=1",
        "last": "https://pushye.com/api/pwas?page=1",
        "next": null,
        "prev": null,
        "self": "https://pushye.com/api/pwas?page=1"
    }
}

检索一个

GET https://pushye.com/api/pwas/{pwa_id}
curl --request GET \
--url 'https://pushye.com/api/pwas/{pwa_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example app",
        "settings": {
            "short_name": "Example",
            "description": "Example PWA application.",
            "start_url": "https://example.com/",
            "display": "standalone",
            "orientation": "any",
            "background_color": "#ffffff",
            "theme_color": "#237fff",
            "app_icon_url": "https://example.com/icon.png",
            "app_icon_maskable_url": "",
            "mobile_screenshot_urls": ["", "", "", "", "", ""],
            "desktop_screenshot_urls": ["", "", "", "", "", ""],
            "shortcuts": [
                {"name": "", "description": "", "url": "", "icon_url": ""},
                {"name": "", "description": "", "url": "", "icon_url": ""},
                {"name": "", "description": "", "url": "", "icon_url": ""}
            ],
            "id": "",
            "dir": "auto",
            "lang": "en",
            "scope_url": "https://example.com/"
        },
        "manifest": {
            "name": "Example app",
            "short_name": "Example",
            "start_url": "https://example.com/",
            "display": "standalone",
            "icons": [
                {
                    "src": "https://example.com/icon.png",
                    "type": "image/png",
                    "purpose": "any",
                    "sizes": "512x512"
                }
            ]
        },
        "last_datetime": null,
        "datetime": "2026-07-28 00:29:07"
    }
}

创建

POST https://pushye.com/api/pwas
参数 细节 描述
name 必需 字符串 The full name of your PWA app - will be shown in your phone home screen or desktop.
short_name 可选的 字符串 Optional short name of your PWA - will be shown when there is not enough room to display the full name.
description 可选的 字符串 Optional short description of your PWA - will be shown in some devices when installing and after installation.
start_url 可选的 字符串 The full URL that opens when your PWA is launched.
background_color 可选的 字符串 The background color used on the splash screen and while the app is loading.
theme_color 可选的 字符串 The browser UI color that matches your app's theme.
app_icon_url 必需 字符串 The main icon of your app. Make sure the icon is 512x512 pixels, PNG file.
app_icon_maskable_url 可选的 字符串 Make sure the icon is 512x512 pixels, PNG file. What is a maskable icon?
mobile_screenshot_url_{1-6} 可选的 字符串 Optional mobile screenshots shown on the installation prompt.
desktop_screenshot_url_{1-6} 可选的 字符串 Optional desktop screenshots shown on the installation prompt.
shortcut_name_{1-3} 可选的 字符串 Name for the shortcut as displayed on the device.
shortcut_description_{1-3} 可选的 字符串 Optional description to explain the shortcut.
shortcut_url_{1-3} 可选的 字符串 URL the shortcut should open.
shortcut_icon_url_{1-3} 可选的 字符串 Make sure the icon is 128x128 pixels, PNG file.
id 可选的 字符串 Optional unique identifier for the PWA. Useful for updates and maintaining identity across installations.
display 可选的 字符串 允许的值：fullscreen, standalone, minimal-ui, browser
orientation 可选的 字符串 允许的值：portrait, landscape, any
dir 可选的 字符串 允许的值：auto, ltr, rtl
lang 可选的 字符串 en for English, de for German, etc.
scope_url 可选的 字符串 Defines the navigation scope of your PWA. Only pages within this scope will be accessible while the app is running. Typically matches the start URL path.
curl --request POST \
--url 'https://pushye.com/api/pwas' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example app' \
--form 'short_name=Example' \
--form 'description=Example PWA application.' \
--form 'start_url=https://example.com/' \
--form 'app_icon_url=https://example.com/icon.png' \
--form 'background_color=#ffffff' \
--form 'theme_color=#237fff' \
--form 'lang=en' \
--form 'scope_url=https://example.com/' 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example app",
        "settings": {
            "short_name": "Example",
            "description": "Example PWA application.",
            "start_url": "https://example.com/",
            "display": "standalone",
            "orientation": "any",
            "background_color": "#ffffff",
            "theme_color": "#237fff",
            "app_icon_url": "https://example.com/icon.png",
            "app_icon_maskable_url": "",
            "mobile_screenshot_urls": ["", "", "", "", "", ""],
            "desktop_screenshot_urls": ["", "", "", "", "", ""],
            "shortcuts": [
                {"name": "", "description": "", "url": "", "icon_url": ""},
                {"name": "", "description": "", "url": "", "icon_url": ""},
                {"name": "", "description": "", "url": "", "icon_url": ""}
            ],
            "id": "",
            "dir": "auto",
            "lang": "en",
            "scope_url": "https://example.com/"
        },
        "manifest": {
            "name": "Example app",
            "short_name": "Example",
            "description": "Example PWA application.",
            "start_url": "https://example.com/",
            "display": "standalone",
            "orientation": "any",
            "background_color": "#ffffff",
            "theme_color": "#237fff",
            "lang": "en",
            "dir": "auto",
            "scope_url": "https://example.com/",
            "icons": [
                {
                    "src": "https://example.com/icon.png",
                    "type": "image/png",
                    "purpose": "any",
                    "sizes": "512x512"
                }
            ]
        },
        "last_datetime": null,
        "datetime": "2026-07-28 00:29:07"
    }
}

更新

POST https://pushye.com/api/pwas/{pwa_id}
参数 细节 描述
name 可选的 字符串 The full name of your PWA app - will be shown in your phone home screen or desktop.
short_name 可选的 字符串 Optional short name of your PWA - will be shown when there is not enough room to display the full name.
description 可选的 字符串 Optional short description of your PWA - will be shown in some devices when installing and after installation.
start_url 可选的 字符串 The full URL that opens when your PWA is launched.
background_color 可选的 字符串 The background color used on the splash screen and while the app is loading.
theme_color 可选的 字符串 The browser UI color that matches your app's theme.
app_icon_url 可选的 字符串 The main icon of your app. Make sure the icon is 512x512 pixels, PNG file.
app_icon_maskable_url 可选的 字符串 Make sure the icon is 512x512 pixels, PNG file. What is a maskable icon?
mobile_screenshot_url_{1-6} 可选的 字符串 Optional mobile screenshots shown on the installation prompt.
desktop_screenshot_url_{1-6} 可选的 字符串 Optional desktop screenshots shown on the installation prompt.
shortcut_name_{1-3} 可选的 字符串 Name for the shortcut as displayed on the device.
shortcut_description_{1-3} 可选的 字符串 Optional description to explain the shortcut.
shortcut_url_{1-3} 可选的 字符串 URL the shortcut should open.
shortcut_icon_url_{1-3} 可选的 字符串 Make sure the icon is 128x128 pixels, PNG file.
id 可选的 字符串 Optional unique identifier for the PWA. Useful for updates and maintaining identity across installations.
display 可选的 字符串 允许的值：fullscreen, standalone, minimal-ui, browser
orientation 可选的 字符串 允许的值：portrait, landscape, any
dir 可选的 字符串 允许的值：auto, ltr, rtl
lang 可选的 字符串 en for English, de for German, etc.
scope_url 可选的 字符串 Defines the navigation scope of your PWA. Only pages within this scope will be accessible while the app is running. Typically matches the start URL path.
curl --request POST \
--url 'https://pushye.com/api/pwas/{pwa_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Updated example app' \
--form 'theme_color=#000000' 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Updated example app",
        "settings": {
            "short_name": "Example",
            "description": "Example PWA application.",
            "start_url": "https://example.com/",
            "display": "standalone",
            "orientation": "any",
            "background_color": "#ffffff",
            "theme_color": "#000000",
            "app_icon_url": "https://example.com/icon.png",
            "app_icon_maskable_url": "",
            "mobile_screenshot_urls": ["", "", "", "", "", ""],
            "desktop_screenshot_urls": ["", "", "", "", "", ""],
            "shortcuts": [
                {"name": "", "description": "", "url": "", "icon_url": ""},
                {"name": "", "description": "", "url": "", "icon_url": ""},
                {"name": "", "description": "", "url": "", "icon_url": ""}
            ],
            "id": "",
            "dir": "auto",
            "lang": "en",
            "scope_url": "https://example.com/"
        },
        "manifest": {
            "name": "Updated example app",
            "short_name": "Example",
            "start_url": "https://example.com/",
            "display": "standalone",
            "theme_color": "#000000",
            "icons": [
                {
                    "src": "https://example.com/icon.png",
                    "type": "image/png",
                    "purpose": "any",
                    "sizes": "512x512"
                }
            ]
        },
        "last_datetime": "2026-07-28 00:29:07",
        "datetime": "2026-07-28 00:29:07"
    }
}

删除

DELETE https://pushye.com/api/pwas/{pwa_id}
curl --request DELETE \
--url 'https://pushye.com/api/pwas/{pwa_id}' \
--header 'Authorization: Bearer {api_key}' \