Glue API: Retrieve push notification providers

Last updated:
Edit on GitHub
This page describes the API endpoint contract, which is the same regardless of the serving infrastructure. Storefront API endpoints are served by API Platform (recommended) or the legacy Glue infrastructure; Backend API endpoints currently run on the Glue infrastructure.

This endpoint lets you retrieve push notification providers to further subscribe to notifications.

Installation

Install the Push Notification feature

Retrieve push notification providers

GET {{backend_url}}/push-notification-providers

PATH DESCRIPTION
{{backend_url}} URL of your Backend Glue API.

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string ✓ Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: GET https://glue-backend.b2c-eu.demo-spryker.com/push-notification-providers

Response

Retrieve push notification providers 
{
    "data": [
        {
            "type": "push-notification-providers",
            "id": "2a304ddf-d51b-514f-bd11-6e818a27fe23",
            "attributes": {
                "uuid": "2a304ddf-d51b-514f-bd11-6e818a27fe23",
                "name": "web-push-php"
            },
            "links": {
                "self": "https://glue-backend.b2c-eu.demo-spryker.com/push-notification-providers/2a304ddf-d51b-514f-bd11-6e818a27fe23"
            }
        },
        {
            "type": "push-notification-providers",
            "id": "ffb5875e-00d3-5436-ae67-08b7c9837f3e",
            "attributes": {
                "uuid": "ffb5875e-00d3-5436-ae67-08b7c9837f3e",
                "name": "Fulfillment App provider"
            },
            "links": {
                "self": "https://glue-backend.b2c-eu.demo-spryker.com/push-notification-providers/ffb5875e-00d3-5436-ae67-08b7c9837f3e"
            }
        }
    ],
    "links": {
        "self": "https://glue-backend.b2c-eu.demo-spryker.com/push-notification-providers"
    }
}
RESOURCE ATTRIBUTE TYPE DESCRIPTION
push-notification-providers uuid String Unique identifier of the provider. It’s used to retrieve or update a provider.
push-notification-providers name String This name is used when subscribing to notifications.

Retrieve a push notification provider

GET {{backend_url}}/push-notification-providers/{{push_notification_provider_id}}***

PATH PARAMETER DESCRIPTON
{{backend_url}} URL of your Backend Glue API.
{{push_notification_provider_id}} ID of a push notification provider to retrieve. To get it, retrieve push notification providers.

Request

HEADER KEY HEADER VALUE REQUIRED DESCRIPTION
Authorization string ✓ Alphanumeric string that authorizes the Back Office user to send requests to protected resources. Get it by authenticating as a Back Office user.

Request sample: GET https://glue-backend.b2c-eu.demo-spryker.com/push-notification-providers/2a304ddf-d51b-514f-bd11-6e818a27fe23

Response

Response sample:

{
    "data": {
        "type": "push-notification-providers",
        "id": "2a304ddf-d51b-514f-bd11-6e818a27fe23",
        "attributes": {
            "uuid": "2a304ddf-d51b-514f-bd11-6e818a27fe23",
            "name": "web-push-php"
        },
        "links": {
            "self": "https://glue-backend.b2c-eu.demo-spryker.com/push-notification-providers/2a304ddf-d51b-514f-bd11-6e818a27fe23"
        }
    }
}
RESOURCE ATTRIBUTE TYPE DESCRIPTION
push-notification-providers uuid String Unique identifier of the provider. It’s used to retrieve or update a provider.
push-notification-providers name String This name is used when subscribing to notifications.

Possible errors

CODE REASON
5001 The push notification provider with the specified ID doesn’t exist.

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.