FFWEB-3114: Introduce API key authorisation

Introduce API key authorisation
FACT-Finder-Web-Components · Jul 18, 2024 · 55b10df · 55b10df
1 parent 91fb8a9
commit 55b10df
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 1 deletion.
diff --git a/spec/Subscriber/ConfigurationSubscriberSpec.php b/spec/Subscriber/ConfigurationSubscriberSpec.php
@@ -64,6 +64,7 @@ public function it_will_return_factfinderchannel_for_specific_sales_channel_id(
         $salesChannel->getId()->willReturn('main_sales_channel');
         $communication->getVersion()->willReturn(Version::NG);
         $communication->getApiVersion()->willReturn('v5');
+        $communication->getApiKey()->willReturn('abc-123');
         $communication->isSsrActive()->willReturn(false);
         $communication->isProxyEnabled()->willReturn(false);
         $communication->getChannel('main_sales_channel')->willReturn('some_ff_channel');
@@ -109,6 +110,7 @@ public function it_will_add_page_extension_for_storefront_render_event(
         $communication->getFieldRoles(Argument::any())->willReturn([]);
         $communication->getVersion()->willReturn(Version::NG);
         $communication->getApiVersion()->willReturn('v5');
+        $communication->getApiKey()->willReturn('abc-123');
         $communication->isSsrActive()->willReturn(false);
         $communication->isProxyEnabled()->willReturn(false);
         $event->getRequest()->willReturn($request);
@@ -150,6 +152,7 @@ public function it_will_throw_exception_when_event_does_not_have_page(
         $communication->getFieldRoles(Argument::any())->willReturn([]);
         $communication->getVersion()->willReturn(Version::NG);
         $communication->getApiVersion()->willReturn('v5');
+        $communication->getApiKey()->willReturn('abc-123');
         $communication->isSsrActive()->willReturn(false);
         $communication->isProxyEnabled()->willReturn(false);
         $event->getRequest()->willReturn($request);

diff --git a/src/Config/Communication.php b/src/Config/Communication.php
@@ -26,6 +26,11 @@ public function getCredentials(): array
         ];
     }
 
+    public function getApiKey(): string
+    {
+        return (string) $this->config('apiKey');
+    }
+
     public function isSsrActive(): bool
     {
         return (bool) $this->config('useSsr');

diff --git a/src/Resources/config/config.xml b/src/Resources/config/config.xml
@@ -34,6 +34,13 @@
             <required>true</required>
         </input-field>
 
+        <input-field>
+            <name>apiKey</name>
+            <label>API key</label>
+            <label lang="de-DE">API-Schlüssel</label>
+            <required>true</required>
+        </input-field>
+
         <input-field type="single-select">
             <name>apiVersion</name>
             <options>

diff --git a/src/Resources/views/storefront/base.html.twig b/src/Resources/views/storefront/base.html.twig
@@ -13,7 +13,7 @@
           ff: {
             url: `{{page.extensions.factfinder.communication.url}}`,
             channel: `{{page.extensions.factfinder.communication.channel}}`,
-            apiKey: `ffng-kwU8a6Sv.aCt0sDZbBLqTerkuuHLG8fhstllFXF`,
+            apiKey: `{{page.extensions.factfinder.communication.apiKey}}`,
           },
           appConfig: {
             debug: true,

diff --git a/src/Subscriber/ConfigurationSubscriber.php b/src/Subscriber/ConfigurationSubscriber.php
@@ -55,6 +55,7 @@ public function onPageLoaded(ShopwareSalesChannelEvent $event): void
         $communication  = [
             'url'                   => $this->getServerUrl(),
             'channel'               => $this->config->getChannel($salesChannelId),
+            'apiKey'                => $this->config->getApiKey(),
             'version'               => $this->config->getVersion(),
             'api'                   => $this->config->getApiVersion(),
             'currencyCode'          => $event->getSalesChannelContext()->getCurrency()->getIsoCode(),