Aareon Connect Direct

Diese Dokumentation zeigt Ihnen wie Sie als Connect Direct-Kunde Ihr Yuneo an an einen unserer Connect-Partner Anbinden können.

Überblick

Connect Direct ermöglicht Partnern einen sicheren API-Zugriff auf Yuneo-Daten.

Das Onboarding umfasst vier Schritte:

  1. Keycloak aktivieren

  2. API-Benutzer anlegen

  3. Backend konfigurieren

  4. Zugangsdaten bereitstellen

circle-info

Pro Partner wird ein eigener API-Benutzer benötigt.

Ablauf

1

1. Keycloak aktivieren

Verantwortlich: Kunde / Aareon

Die Nutzung von Aareon Connect Direct setzt Keycloak voraus.

SaaS-Kunden

  • Die Umstellung erfolgt durch den Kunden selbst direkt im System.

  • Navigation: Optionen → Allgemein → Multifaktorauthentifizierung

  • Planen Sie etwa 14 Tage Vorlauf ein.

  • Die Umstellung kann auch vor Vertragsunterzeichnung erfolgen.

On-Premise-Kunden

  • Die Umstellung erfolgt durch Aareon IT Infrastruktur oder Aareon Consultants.

  • Erstellen Sie dafür ein Zendesk-Ticket an IT Infrastruktur.

Verwenden Sie dabei diesen Text:

Bitte um Umstellung auf das aktuelle Keycloak-Authentifizierungsverfahren für unser In-House-System. Die Umstellung ist Voraussetzung für die Connect Direct Anbindung an [Partnername].

circle-info

Keycloak ist eine zentrale Authentifizierungs- und Autorisierungslösung, die von Aareon eingesetzt wird. Sie ermöglicht eine sichere Anmeldung (z. B. über OAuth2/OpenID Connect) und bildet die Grundlage für den API-Zugriff bei Aareon Connect Direct.

Die Nutzung von Aareon Connect Direct setzt Keycloak zwingend voraus. Alle Kunden (SaaS und On-Premise) müssen Keycloak aktivieren, bevor die Anbindung erfolgen kann.

2

2. Yuneo-Benutzer für Schnittstelle anlegen

Verantwortlich: Kunde

Der Kunde legt nach der Keycloak-Umstellung einen Yuneo Benutzer an, welcher für den Zugriff auf die API genutzt werden kann. Folgende Schritte müssen genau befolgt werden:

Benutzerdaten

  • Neuen Benutzer hinzufügen

  • Benutzername / E-Mail: svc_<partner_name>@aareon.com

  • Nachname: Partnername

  • Option Alle Mandanten aktivieren

  • Partnerspezifische Benutzerrolle zuweisen

circle-info

Die Benutzerrolle richten Sie in Yuneo unter „Benutzerrollen“ ein. Anschließend weisen Sie diese Rolle dem entsprechenden Yuneo-Benutzer zu.

Sobald der Benutzer angelegt wurde, informieren Sie uns bitte per E-Mail. Eine kurze Nachricht an [email protected] mit dem Benutzernamen sowie dem Hinweis, dass der Benutzer erfolgreich erstellt wurde, ist hierfür ausreichend.

3

3. Backend konfigurieren

Verantwortlich: Aareon / Yuneo

  • Dieser Schritt erfolgt vollständig durch Aareon, nachdem Sie Schritt 2 erledigt haben.

  • Einrichtung im API Gateway

  • Verknüpfung von Kunde, Benutzer und Partner

Wenn Schritt 1 und 2 abgeschlossen sind, ist hier keine Aktion des Kunden nötig.

4

4. Zugangsdaten bereitstellen

Verantwortlich: Aareon

Nach Abschluss aller Schritte erstellt Aareon die API-Zugangsdaten je Kunde und Partner.

Die Zugangsdaten werden anschließend an den jeweiligen Partner übermittelt.

Checkliste

Die Anbindung ist abgeschlossen, wenn diese Punkte erfüllt sind:

  • Keycloak ist aktiviert.

  • Der API-Benutzer ist je Partner angelegt.

  • Das Backend ist durch Aareon konfiguriert.

  • Die Zugangsdaten wurden bereitgestellt.

Last updated

Was this helpful?