Added Interceptor to enrich requests with api sandbox header for api …

README.md

@@ -95,6 +95,18 @@ We've provided the `AuthEventsHandlerService` via the `APP_INITIALIZER` which wi
 
 We've also provided an example implementation of an `AuthInterceptor` in the app module. The purpose of this interceptor is to catch 401 errors and attempt to refresh the user's access token. If this refresh is successful the original request will be replayed with the new access token. If the refresh fails, or the original error was not a 401, then we surface the original error to the calling code.
 
+### How to use API Sandbox endpoints
+
+Since API Sandbox requires an individual API Key to allow requests to go through the services, you need to request a new API Key for yourself. You can do this by sending an email to `api-sandbox-support@backbase.com`.
+
+When you receive your API Key, you can add it to your environment file. For example, in `environment.ts`:
+
+```ts
+export const environment: Environment = {
+  apiSandboxKey: 'YOUR_API_KEY'
+}
+```
+
 ## Generate an application
 
 Run `ng g @nx/angular:app my-app` to generate an application.

apps/golden-sample-app/src/app/app.module.ts

@@ -46,6 +46,7 @@ import { LocaleSelectorModule } from './locale-selector/locale-selector.module';
 import { TrackerModule } from '@backbase/foundation-ang/observability';
 import { UserContextInterceptor } from './user-context/user-context.interceptor';
 import { ActivityMonitorModule } from './auth/activity-monitor';
+import { ApiSandboxInterceptor } from '../environments/api-sandbox-interceptor';
 import packageInfo from 'package-json';
 import { ThemeSwitcherModule } from './theme-switcher/theme-switcher.component.module';
 import { ThemeManagerService } from './theme-switcher/theme-service';
@@ -169,6 +170,11 @@ import { ThemeManagerService } from './theme-switcher/theme-service';
         accessControlBasePath: `${environment.apiRoot}/access-control`,
       },
     },
+    {
+      provide: HTTP_INTERCEPTORS,
+      useClass: ApiSandboxInterceptor,
+      multi: true,
+    },
     {
       provide: ErrorHandler,
       useClass: AppErrorHandler,

apps/golden-sample-app/src/environments/api-sandbox-interceptor.ts

@@ -0,0 +1,23 @@
+import { HttpInterceptor, HttpRequest, HttpHandler, HttpEvent } from '@angular/common/http';
+import { Injectable } from '@angular/core';
+import { Observable } from 'rxjs';
+import { environment } from './environment';
+
+@Injectable()
+export class ApiSandboxInterceptor implements HttpInterceptor {
+  intercept(req: HttpRequest<any>, next: HttpHandler): Observable<HttpEvent<any>> {
+    const apiSandboxKey = environment.apiSandboxKey;
+
+    if (!req.url.includes(environment.apiRoot) || !apiSandboxKey) {
+      return next.handle(req);
+    }
+
+    const newReq = req.clone({
+      setHeaders: {
+        'X-SDBXAZ-API-KEY': apiSandboxKey,
+      }
+    });
+
+    return next.handle(newReq);
+  }
+}

apps/golden-sample-app/src/environments/environment.prod.ts

@@ -5,6 +5,7 @@ export const environment: Environment = {
   production: true,
   apiRoot: '${API_ROOT}',
   locales: '${LOCALES}'.split(','),
+  apiSandboxKey: '${X-SDBXAZ-API-KEY}',
   common: {
     designSlimMode: false,
   },

apps/golden-sample-app/src/environments/environment.ts

@@ -21,6 +21,7 @@ export const environment: Environment = {
   apiRoot: 'https://app.stg.sdbxaz.azure.backbaseservices.com/api',
   mockProviders,
   locales: ['en-US', 'nl-NL'],
+  apiSandboxKey: 'sandboxApiKey',
   common: {
     designSlimMode: false,
   },

apps/golden-sample-app/src/environments/type.ts

@@ -11,6 +11,7 @@ export interface Environment {
   mockProviders?: Provider[];
   mockEnabled?: boolean;
   common: sharedJourneyConfiguration;
+  apiSandboxKey?: string;
   isTelemetryTracerEnabled?: boolean;
   bbApiKey?: string;
   telemetryCollectorURL?: string;

docker-compose.yml

@@ -18,3 +18,4 @@ services:
       AUTH_CLIENT_ID: bb-web-client
       LOCALES: en,nl
       FALLBACK_LOCALE: nl
+      X-SDBXAZ-API-KEY: sandboxApiKey