Glue API: Retrieve protected resources

Last updated:
Edit on GitHub

Since shop owners can define which resources are protected, the list is different in each shop. That’s why, before sending any requests, you might need to check which resources are protected and authenticate.

In your development, the Customer Access API helps you to protect resources from guest access and perform pre-flight checks to avoid sending requests to protected resources without authentication.

Installation

For detailed information on the modules that provide the API functionality and related installation instructions, see Glue API: Customer Access feature integration.

Retrieve protected resources

To retrieve protected resources, send the request:

GET /customer-access

Request

Request sample: retrieve protected resources

GET http://glue.mysprykershop.com/customer-access

Response

Response sample: retrieve protected resources

{
    "data": [
        {
            "type": "customer-access",
            "id": null,
            "attributes": {
                "resourceTypes": [
                    "abstract-product-prices",
                    "concrete-product-prices",
                    "wishlists",
                    "wishlist-items"
                ]
            },
            "links": {
                "self": "https://glue.mysprykershop.com/customer-access"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/customer-access"
    }
}
ATTRIBUTE TYPE DESCRIPTION
resourceTypes String Contains a string array, where each element is a resource type that is protected from unauthorized access.

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