Install the Customer Access Glue API
Edit on GitHubThe following feature integration guide expects the basic feature to be in place. The current feature integration Guide only adds the Company Account REST API functionality.
Install Feature API
Prerequisites
To start the feature integration, overview and install the necessary features:
NAME | VERSION | INSTALLATION GUIDE |
---|---|---|
Spryker Core | 202307.0 | Feature API |
Customer Access | 202307.0 | Feature |
1) Install the required modules
Run the following command to install the required modules:
composer require spryker/customer-access-rest-api:"^1.1.0" --update-with-dependencies
Make sure that the following module has been installed:
MODULE | EXPECTED DIRECTORY |
---|---|
CustomerAccessRestApi |
vendor/spryker/customer-access-rest-api |
2) Set up configuration
Add the following configuration:
PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
---|---|---|---|
CustomerAccessRestApiConfig::CUSTOMER_ACCESS_CONTENT_TYPE_TO_RESOURCE_TYPE_MAPPING | Array that provides a mapping between customer access content types and the corresponding REST resource names. | None | \Spryker\Glue\CustomerAccessRestApi |
src/Pyz/Glue/CustomerAccessRestApi/CustomerAccessRestApiConfig.php
<?php
namespace Pyz\Glue\CustomerAccessRestApi;
use Spryker\Glue\CheckoutRestApi\CheckoutRestApiConfig;
use Spryker\Glue\CartsRestApi\CartsRestApiConfig;
use Spryker\Glue\CustomerAccessRestApi\CustomerAccessRestApiConfig as SprykerCustomerAccessRestApiConfig;
use Spryker\Glue\ProductPricesRestApi\ProductPricesRestApiConfig;
use Spryker\Glue\WishlistsRestApi\WishlistsRestApiConfig;
use Spryker\Shared\CustomerAccess\CustomerAccessConfig;
class CustomerAccessRestApiConfig extends SprykerCustomerAccessRestApiConfig
{
protected const CUSTOMER_ACCESS_CONTENT_TYPE_TO_RESOURCE_TYPE_MAPPING = [
CustomerAccessConfig::CONTENT_TYPE_PRICE => [
ProductPricesRestApiConfig::RESOURCE_ABSTRACT_PRODUCT_PRICES,
ProductPricesRestApiConfig::RESOURCE_CONCRETE_PRODUCT_PRICES,
],
CustomerAccessConfig::CONTENT_TYPE_ORDER_PLACE_SUBMIT => [
CheckoutRestApiConfig::RESOURCE_CHECKOUT,
CheckoutRestApiConfig::RESOURCE_CHECKOUT_DATA,
],
CustomerAccessConfig::CONTENT_TYPE_ADD_TO_CART => [
CartsRestApiConfig::RESOURCE_GUEST_CARTS_ITEMS,
],
CustomerAccessConfig::CONTENT_TYPE_WISHLIST => [
WishlistsRestApiConfig::RESOURCE_WISHLISTS,
WishlistsRestApiConfig::RESOURCE_WISHLIST_ITEMS,
],
];
}
3) Set up transfer objects
Run the following command to generate transfer changes:
console transfer:generate
Make sure that the following changes have occurred:
TRANSFER | TYPE | EVENT | PATH |
---|---|---|---|
RestCustomerAccessAttributesTransfer | class | created | src/Generated/Shared/Transfer/RestCustomerAccessAttributesTransfer |
4) Set up behavior
Enable resources
Activate the following plugins:
PLUGIN | SPECIFICATION | PREREQUISITES | NAMESPACE |
---|---|---|---|
CustomerAccessResourceRoutePlugin | Registers the customer-access resource. |
None | Spryker\Glue\CustomerAccessRestApi\Plugin\GlueApplication |
CustomerAccessFormatRequestPlugin | Checks whether the current resource is restricted by the spryker/customer-access module. |
None | Spryker\Glue\CustomerAccessRestApi\Plugin\GlueApplication |
src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php
<?php
namespace Pyz\Glue\GlueApplication;
use Spryker\Glue\CustomerAccessRestApi\Plugin\GlueApplication\CustomerAccessFormatRequestPlugin;
use Spryker\Glue\CustomerAccessRestApi\Plugin\GlueApplication\CustomerAccessResourceRoutePlugin;
use Spryker\Glue\GlueApplication\GlueApplicationDependencyProvider as SprykerGlueApplicationDependencyProvider;
class GlueApplicationDependencyProvider extends SprykerGlueApplicationDependencyProvider
{
/**
* @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRoutePluginInterface[]
*/
protected function getResourceRoutePlugins(): array
{
return [
new CustomerAccessResourceRoutePlugin(),
];
}
/**
* @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\FormatRequestPluginInterface[]
*/
protected function getFormatRequestPlugins(): array
{
return [
new CustomerAccessFormatRequestPlugin(),
];
}
}
Make that following endpoint is available:
https://glue.mysprykershop.com/customer-access
Sample response
{
"data": [
{
"type": "customer-access",
"id": null,
"attributes": {
"resourceTypes": [
"wishlists",
"wishlist-items"
]
},
"links": {
"self": "https://glue.mysprykershop.com/customer-access"
}
}
],
"links": {
"self": "https://glue.mysprykershop.com/customer-access"
}
}
Make sure that CustomerAccessFormatRequestPlugin
is set up correctly:
- Go to the Customer Access tab in Spryker Back Office and hide the
price
content. - Make a request to:
https://glue.mysprykershop.com/abstract-products/{{abstract-sku}}/abstract-product-prices
- Make sure that the response is a 403 error.
Sample response
{
"errors": [
{
"detail": "Missing access token.",
"status": 403,
"code": "002"
}
]
}
Thank you!
For submitting the form