Install the Merchant Profile Backend API

This document describes how to install the Merchant Profile Backend API, which lets merchant users manage the profile of their merchant through the merchant-profile resource and Back Office users manage any merchant profile through the merchant-profiles resource of the Backend API.

Prerequisites

Install the required features:

Merchant users authenticate with the merchant-user scope. To register the plugins that provide it, follow the Optional: Enable merchant user authentication step of the Backend API authentication integration guide. To restrict merchant users to the data of their merchant, follow Integrate Persistent ACL for merchant API endpoints.

Install feature core

1) Install the required modules

Install the required modules using Composer:

composer require \
  spryker/merchant-profile:"^1.11.0" \
  spryker/merchant-user:"^1.10.0" \
  spryker/api-platform:"^1.30.0" \
  spryker/oauth-backend-api:"^1.8.0" \
  spryker/user:"^3.33.0" \
  --update-with-dependencies

2) Set up transfer objects

Generate the transfer classes:

console transfer:generate

3) Set up behavior

On the merchant-profile resource, a merchant user is held to the rules of the Merchant Portal profile page. The rules are validator plugins; register them:

src/Pyz/Glue/MerchantProfile/MerchantProfileDependencyProvider.php

<?php

namespace Pyz\Glue\MerchantProfile;

use Spryker\Glue\MerchantProfile\MerchantProfileDependencyProvider as SprykerMerchantProfileDependencyProvider;
use Spryker\Glue\MerchantProfile\Plugin\MerchantProfile\HtmlTagWhitelistMerchantProfileValidatorPlugin;
use Spryker\Glue\MerchantProfile\Plugin\MerchantProfile\StoreLocaleMerchantProfileValidatorPlugin;

class MerchantProfileDependencyProvider extends SprykerMerchantProfileDependencyProvider
{
    /**
     * @return array<\Spryker\Glue\MerchantExtension\Dependency\Plugin\MerchantProfileValidatorPluginInterface>
     */
    protected function getMerchantProfileValidatorPlugins(): array
    {
        return [
            new StoreLocaleMerchantProfileValidatorPlugin(),
            new HtmlTagWhitelistMerchantProfileValidatorPlugin(),
        ];
    }
}

The plugins apply to the merchant-profile resource only; the merchant-profiles resource of the Back Office user carries none of these rules, as the Back Office merchant form doesn’t. To add a project-specific rule, implement Spryker\Glue\MerchantExtension\Dependency\Plugin\MerchantProfileValidatorPluginInterface and register the plugin in the same method. The allowed HTML tags and the URL prefix segment that is prepended to submitted merchant URLs (merchant in /de/merchant/spryker) are configured in Spryker\Glue\MerchantProfile\MerchantProfileConfig.

4) Generate the API resources

The resources are auto-discovered from the module; no plugin registration is needed. Generate the resource classes and rebuild the Backend API container:

vendor/bin/glue api:generate
console cache:empty-all