Übersicht über die Schritte zum Onboarding und Nutzung der Arvato AEP.API als SaaS Lösung für API-Prozesse.

Die folgende Dokumentation beschreibt benötigten Schritte zum Onboarding und Nutzung des AEP.API-Systems als SaaS Lösung auf der AEP/CRISP Plattform.

AEP.API Workflows

Eine Übersicht über das Zusammenspiel der AEP.API Services finden Sie in der AEP.API Beschreibung.

Onboarding-Guide

Anbindung an die AEP.API SaaS Lösung

Die AEP.API Microservices stellen wir (in der Regel) als SaaS Lösung bereit. Zur Anbindung des AEP.API Systems an Ihre Systeme müssen die AEP.API AMQP Schnittstellen implementiert werden.

Standardmäßig wird das AEP.API System an ein B2B-System angeschlossen. Die B2B übernimmt hierbei die Rollen

  • des API-Anfrage Monitorings (über den B2B Nachrichten-Monitor) und
  • speichert API-Anfrage (optional für eine spätere Archivierung) und
  • leitet die API-Anfragen an Backend-Systeme weiter. Hierzu können alle bekannten B2B Schnittstellen/Protokolle genutzt werden.

Das AEP.API System verfügt zum Austausch von API-Anfragen mit dem Backend/Monitoring-Systemen über drei AMQP-Schnittstellen:

AEP.API-IntegrationOverview.png

Die Schnittstellen-Dokumentation (interner Link) stellt unser Support Ihnen bei Anfrage gerne zur Verfügung. Dies lässt sich beispielsweise durch AsyncAPI Studio darstellen.

Sollten sie kein B2B-System (also bereits haben oder durch uns bereitgestellt bekommen) anbinden wollen, so müssen Sie eine alternative Anwendung nutzen, die die AEP.API AMQP-Schnittstellen für die API-Anfragen implementiert und das Monitoring sowie Speichern der API-Anfragen übernimmt.

Installation des b2b-message-service

Im Standard wird das AEP.API System an ein B2B-System angeschlossen. Hierzu stellen wir den b2b-message-service als AMQP Adapter bereit, der genau diese Schnittstellen implementiert.

  • der B2B-Message-Service als AMQP Adapter der B2B zu installieren, welcher genau die AMQP Schnittstellen des AEP.API-Systems implementiert, und
  • das B2B Customizing für die API-Verarbeitung einzurichten.

Der b2b-message-service muss (sofern nicht bereits für AS4 genutzt) als AMQP-Adapter zur B2B installiert werden, siehe Installation des b2b-message-service.

Hierbei werden in der AEP.API SaaS Lösung je Kunde und Mandanten-B2B eigene AMQP-Queue Schnittstellen eingerichtet, welche über Shared Access Signatures abgesichert sind. Die vertraulichen privaten Schlüssel, mit denen die individuellen Queues abgesichert sind, werden bei der Provisionierung unserer AEP.API SaaS-Lösung erstellt. Die Schlüssel (auch ConnectionStrings genannt) können nur durch unsere Admins mit besonderen Rechten temporär eingesehen (oder bei Bedarf neu erstellt) werden. Ihnen werden diese Schlüssel im Rahmen des Onboardings bereitgestellt, welche dann in der Konfiguration Ihrer b2b-message-service Installation hinterlegt werden müssen.

Konfiguration des B2B-Workflows für API-Anfragen

Hierzu finden Sie kurze Anleitungen für die

API-Zertifikatserstellung

Vor der Inbetriebnahme des AEP.API Systems werden für jeden Mandanten Zertifikate benötigt. Hier unterstützen wir wie folgt im Prozess zur Zertifikatserstellung für Kunden unserer SaaS-Lösung: …

Alternative: Eigene OnPremise Installation (nicht empfohlen, nur nach Abstimmung)

Voraussetzungen

Für eine OnPremise Installation der AEP.API Lösung sind folgende Voraussetzungen zu erfüllen:

  • RabbitMQ - Das AEP.API-System benötigt einen Message-Broker.
  • FSS & HSM - Das AEP.API-Systems benötigt einen FSS und ein HSM zur Zertifikatsverwaltung und Schlüsselspeicherung.

Daneben benötigt der api-address-service eine Datenbank. Wir unterstützen hierbei Postgres und Oracle. Weitere Details zu den Datenbanken sind der Dokumentation der einzelnen Microservices zu entnehmen.

Microservice Konfiguration

Die Konfiguration der AEP.API Microservices ist auf den jeweiligen Seiten beschrieben:

API-Mandanten konfigurieren

Alle Mandanten müssen innerhalb des Systems konfiguriert werden. Eine Anleitung diesbezüglich finden Sie hier.

API-Zertifikatserstellung

Bevor das AEP.API System in Betrieb genommen werden kann, müssen je Mandant mithilfe unserer Lösung Zertifikate erstellt und eingespielt werden.

Darüber hinaus müssen auch Aussteller-Zertifikate & Partner-Zertifikate importiert werden. Durch eine erweiterte Konfiguration des certificate-managers können diese automatisiert importiert werden.

View Me   Edit Me