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 オプション 整数 1ページあたりの結果数はどのくらいにしますか。許可されている値は：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-29 04:20:32"
        }
    ],
    "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"
    }
}

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-29 04:20:32"
    }
}

作成する

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-29 04:20:32"
    }
}

更新

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-29 04:20:32",
        "datetime": "2026-07-29 04:20:32"
    }
}

削除

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