PWAs

Récupérer tout

GET https://pushye.com/api/pwas/
curl --request GET \
--url 'https://pushye.com/api/pwas/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
search Optionnel Chaîne La chaîne de recherche.
search_by Optionnel Chaîne Quel champ recherchez-vous ? Les valeurs autorisées sont : name.
datetime_field Optionnel Chaîne Valeurs autorisées : datetime, last_datetime
datetime_start Optionnel Chaîne Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Optionnel Chaîne Filter results up to this datetime. Y-m-d H:i:s format.
order_by Optionnel Chaîne Quel champ pour trier les résultats. Les valeurs autorisées sont : pwa_id, name, datetime, last_datetime.
order_type Optionnel Chaîne L'ordre des résultats. Les valeurs autorisées sont : ASC pour un ordre croissant, et DESC pour un ordre décroissant.
page Optionnel Entier Le numéro de page dont vous souhaitez obtenir les résultats. Par défaut, c'est 1.
results_per_page Optionnel Entier Combien de résultats souhaitez-vous par page ? Les valeurs autorisées sont : 10, 25, 50, 100, 250, 500, 1000. Par défaut, c'est 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 03:24:24"
        }
    ],
    "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"
    }
}

Récupérer un

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 03:24:24"
    }
}

Créer

POST https://pushye.com/api/pwas
Paramètres Détails Description
name Requis Chaîne The full name of your PWA app - will be shown in your phone home screen or desktop.
short_name Optionnel Chaîne Optional short name of your PWA - will be shown when there is not enough room to display the full name.
description Optionnel Chaîne Optional short description of your PWA - will be shown in some devices when installing and after installation.
start_url Optionnel Chaîne The full URL that opens when your PWA is launched.
background_color Optionnel Chaîne The background color used on the splash screen and while the app is loading.
theme_color Optionnel Chaîne The browser UI color that matches your app's theme.
app_icon_url Requis Chaîne The main icon of your app. Make sure the icon is 512x512 pixels, PNG file.
app_icon_maskable_url Optionnel Chaîne Make sure the icon is 512x512 pixels, PNG file. What is a maskable icon?
mobile_screenshot_url_{1-6} Optionnel Chaîne Optional mobile screenshots shown on the installation prompt.
desktop_screenshot_url_{1-6} Optionnel Chaîne Optional desktop screenshots shown on the installation prompt.
shortcut_name_{1-3} Optionnel Chaîne Name for the shortcut as displayed on the device.
shortcut_description_{1-3} Optionnel Chaîne Optional description to explain the shortcut.
shortcut_url_{1-3} Optionnel Chaîne URL the shortcut should open.
shortcut_icon_url_{1-3} Optionnel Chaîne Make sure the icon is 128x128 pixels, PNG file.
id Optionnel Chaîne Optional unique identifier for the PWA. Useful for updates and maintaining identity across installations.
display Optionnel Chaîne Valeurs autorisées : fullscreen, standalone, minimal-ui, browser
orientation Optionnel Chaîne Valeurs autorisées : portrait, landscape, any
dir Optionnel Chaîne Valeurs autorisées : auto, ltr, rtl
lang Optionnel Chaîne en for English, de for German, etc.
scope_url Optionnel Chaîne 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 03:24:24"
    }
}

Mise à jour

POST https://pushye.com/api/pwas/{pwa_id}
Paramètres Détails Description
name Optionnel Chaîne The full name of your PWA app - will be shown in your phone home screen or desktop.
short_name Optionnel Chaîne Optional short name of your PWA - will be shown when there is not enough room to display the full name.
description Optionnel Chaîne Optional short description of your PWA - will be shown in some devices when installing and after installation.
start_url Optionnel Chaîne The full URL that opens when your PWA is launched.
background_color Optionnel Chaîne The background color used on the splash screen and while the app is loading.
theme_color Optionnel Chaîne The browser UI color that matches your app's theme.
app_icon_url Optionnel Chaîne The main icon of your app. Make sure the icon is 512x512 pixels, PNG file.
app_icon_maskable_url Optionnel Chaîne Make sure the icon is 512x512 pixels, PNG file. What is a maskable icon?
mobile_screenshot_url_{1-6} Optionnel Chaîne Optional mobile screenshots shown on the installation prompt.
desktop_screenshot_url_{1-6} Optionnel Chaîne Optional desktop screenshots shown on the installation prompt.
shortcut_name_{1-3} Optionnel Chaîne Name for the shortcut as displayed on the device.
shortcut_description_{1-3} Optionnel Chaîne Optional description to explain the shortcut.
shortcut_url_{1-3} Optionnel Chaîne URL the shortcut should open.
shortcut_icon_url_{1-3} Optionnel Chaîne Make sure the icon is 128x128 pixels, PNG file.
id Optionnel Chaîne Optional unique identifier for the PWA. Useful for updates and maintaining identity across installations.
display Optionnel Chaîne Valeurs autorisées : fullscreen, standalone, minimal-ui, browser
orientation Optionnel Chaîne Valeurs autorisées : portrait, landscape, any
dir Optionnel Chaîne Valeurs autorisées : auto, ltr, rtl
lang Optionnel Chaîne en for English, de for German, etc.
scope_url Optionnel Chaîne 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 03:24:24",
        "datetime": "2026-07-29 03:24:24"
    }
}

Supprimer

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