Install the Agent Assist Glue API

Last updated:
Edit on GitHub

Follow the steps below to install the Agent Assist feature API.

Prerequisites

To start the feature integration, overview and install the necessary features:

NAME VERSION INSTALLATION GUIDE
Spryker Core 202404.0 Install the Spryker Core Glue API
Customer Account Management + Agent Assist 202404.0 Install the Customer Account Management + Agent Assist feature

1) Install the required modules

Run the following command to install the required modules:

composer require spryker/agent-auth-rest-api:"^1.0.0" --update-with-dependencies
Verification

Ensure that the following module has been installed:

MODULE EXPECTED DIRECTORY
AgentAuthRestApi vendor/spryker/agent-auth-rest-api

2) Set up transfer objects

Generate transfer changes:

console transfer:generate
Verification

Ensure that the following changes have been applied in the transfer objects:

TRANSFER TYPE EVENT PATH
RestAgentAccessTokensRequestAttributesTransfer cell cell src/Generated/Shared/Transfer/RestAgentAccessTokensRequestAttributesTransfer
RestAgentAccessTokensAttributesTransfer class created src/Generated/Shared/Transfer/RestAgentAccessTokensAttributesTransfer
RestAgentCustomerImpersonationAccessTokensRequestAttributesTransfer class created src/Generated/Shared/Transfer/RestAgentCustomerImpersonationAccessTokensRequestAttributesTransfer
RestAgentCustomerImpersonationAccessTokensAttributesTransfer class created src/Generated/Shared/Transfer/RestAgentCustomerImpersonationAccessTokensAttributesTransfer
RestAgentCustomerSearchAttributesTransfer class created src/Generated/Shared/Transfer/RestAgentCustomerSearchAttributesTransfer
RestAgentCustomerSearchCustomersAttributesTransfer class created src/Generated/Shared/Transfer/RestAgentCustomerSearchCustomersAttributesTransfer
RestUserTransfer.idAgent property created src/Generated/Shared/Transfer/RestUserTransfer
CustomerQueryTransfer class created src/Generated/Shared/Transfer/CustomerQueryTransfer
OauthRequestTransfer class created src/Generated/Shared/Transfer/OauthRequestTransfer
RestErrorCollectionTransfer class created src/Generated/Shared/Transfer/RestErrorCollectionTransfer
RestErrorMessageTransfer class created src/Generated/Shared/Transfer/RestErrorMessageTransfer
OauthAccessTokenValidationRequestTransfer class created src/Generated/Shared/Transfer/OauthAccessTokenValidationRequestTransfer
CustomerAutocompleteResponseTransfer class created src/Generated/Shared/Transfer/CustomerAutocompleteResponseTransfer
PaginationTransfer class created src/Generated/Shared/Transfer/PaginationTransfer
OauthResponseTransfer class created src/Generated/Shared/Transfer/OauthResponseTransfer
OauthAccessTokenDataTransfer class created src/Generated/Shared/Transfer/OauthAccessTokenDataTransfer
OauthAccessTokenValidationResponseTransfer class created src/Generated/Shared/Transfer/OauthAccessTokenValidationResponseTransfer
CustomerTransfer class created src/Generated/Shared/Transfer/CustomerTransfer

3) Set up behavior

Activate the following plugins:

PLUGIN SPECIFICATION PREREQUISITES NAMESPACE
AgentRestUserMapperPlugin Maps Agent data to the Rest user identifier. None Spryker\Glue\AgentAuthRestApi\Plugin\AuthRestApi
AgentAccessTokenRestRequestValidatorPlugin Validates the access token passed via the X-Agent-Authorization header. None Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication
AgentRestUserValidatorPlugin Checks if the RestRequest.restUser is an Agent when an agent-only resource is accessed. None Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication
AgentAccessTokenRestUserFinderPlugin Finds the Rest user for the X-Agent-Authorization header. None Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication
AgentAccessTokensResourceRoutePlugin Provides the /agent-access-tokens resource route. None Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication
AgentCustomerImpersonationAccessTokensResourceRoutePlugin Provides the /agent-customer-impersonation-access-tokens resource route. The Customer impersonation grant type must be configured. See the Install the Customer Account Management feature for details. Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication
AgentCustomerSearchResourceRoutePlugin Provides the /agent-customer-search resource route. None Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication
src/Pyz/Glue/GlueApplication/GlueApplicationDependencyProvider.php 
<?php

namespace Pyz\Glue\GlueApplication;

use Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication\AgentAccessTokenRestRequestValidatorPlugin;
use Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication\AgentAccessTokenRestUserFinderPlugin;
use Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication\AgentAccessTokensResourceRoutePlugin;
use Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication\AgentCustomerImpersonationAccessTokensResourceRoutePlugin;
use Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication\AgentCustomerSearchResourceRoutePlugin;
use Spryker\Glue\AgentAuthRestApi\Plugin\GlueApplication\AgentRestUserValidatorPlugin;
use Spryker\Glue\GlueApplication\GlueApplicationDependencyProvider as SprykerGlueApplicationDependencyProvider;

class GlueApplicationDependencyProvider extends SprykerGlueApplicationDependencyProvider
{
    /**
     * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\ResourceRoutePluginInterface[]
     */
    protected function getResourceRoutePlugins(): array
    {
        return [
            new AgentAccessTokensResourceRoutePlugin(),
            new AgentCustomerImpersonationAccessTokensResourceRoutePlugin(),
            new AgentCustomerSearchResourceRoutePlugin(),
        ];
    }



    /**
     * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RestRequestValidatorPluginInterface[]
     */
    protected function getRestRequestValidatorPlugins(): array
    {
        return [
            new AgentAccessTokenRestRequestValidatorPlugin(),
        ];
    }

    /**
     * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RestUserValidatorPluginInterface[]
     */
    protected function getRestUserValidatorPlugins(): array
    {
        return [
            new AgentRestUserValidatorPlugin(),
        ];
    }

    /**
     * @return \Spryker\Glue\GlueApplicationExtension\Dependency\Plugin\RestUserFinderPluginInterface[]
     */
    protected function getRestUserFinderPlugins(): array
    {
        return [
            new AgentAccessTokenRestUserFinderPlugin(),
        ];
    }
}
Verification

Ensure that:

  • Invalid agent access tokens passed in the X-Agent-Authorization header are rejected with the 401 error code.

  • The X-Agent-Authorization header is required for /agent-customer-impersonation-access-tokens and /agent-customer-search resources. Requests without the header return the 401 error code.

  • When a valid agent access token is provided via the X-Agent-Authorization, the RestRequest object in Glue controllers populates restUser.idAgent with the current agent identifier.

  • The following resources are available:

RESOURCE REQUEST TO CHECK
/agent-access-tokens POST https://glue.mysprykershop.com/agent-access-tokens
/agent-customer-impersonation-access-tokens POST https://glue.mysprykershop.com/agent-customer-impersonation-access-tokens
/agent-customer-search GET https://glue.mysprykershop.com/agent-customer-search

src/Pyz/Glue/AuthRestApi/AuthRestApiDependencyProvider.php

<?php

namespace Pyz\Glue\AuthRestApi;

use Spryker\Glue\AgentAuthRestApi\Plugin\AuthRestApi\AgentRestUserMapperPlugin;
use Spryker\Glue\AuthRestApi\AuthRestApiDependencyProvider as SprykerAuthRestApiDependencyProvider;

class AuthRestApiDependencyProvider extends SprykerAuthRestApiDependencyProvider
{
    /**
     * @return \Spryker\Glue\AuthRestApiExtension\Dependency\Plugin\RestUserMapperPluginInterface[]
     */
    protected function getRestUserExpanderPlugins(): array
    {
        return [
            new AgentRestUserMapperPlugin(),
        ];
    }
}
Verification

Ensure that, when Authorization and X-Agent-Authorization headers are sent, RestRequest.restUser is populated with Customer and Agent information.

Integrate the following related features:

FEATURE INSTALLATION GUIDE
Customer account management Install the Customer Account Management feature
Customer account management + Agent assist Install the Customer Account Management + Agent Assist feature