Zum Hauptinhalt springen

Onboarding

Einführung​

Die Cloud Gateway Onboarding API ermöglicht die eigenständige Anbindung neuer DATEV-Systeme durch Kunden, ohne direkte Interaktion mit dem Softwareanbieter. Der Prozess stellt sicher, dass alle erforderlichen Berechtigungen, IT-Partner-Details und Identitätsprüfungen durchlaufen werden, bevor der Zugriff auf das System gewährt wird.

Die Nutzung der Onboarding API benötigt derzeit (da sich dieses Feature in der Pilotphase befindet) eine aktive Freischaltung durch das Cloud Gateway Support Team.

Vorteile des Self-Onboardings​

  • Autonomie: Kunden können sich eigenständig registrieren, ohne dass der Softwareanbieter manuell eingreifen muss.
  • Schnelligkeit: Die Onboarding-Dauer wird durch integrierte Signaturprozesse reduziert.
  • Bessere Akzeptanz: IT-Partner erhalten klare Anweisungen und Downloads für die notwendige Software.

Voraussetzungen​

Um den Self-Onboarding-Prozess erfolgreich durchzuführen, müssen folgende Bedingungen erfüllt sein:

  • Der Benutzer muss Steuerberater, Mandant eines Steuerberaters oder ein Unternehmen sein.
  • Die Identifizierung erfolgt über eine DATEV Smart Card (mIdentity, Smart Login) oder einen gültigen Identitätsnachweis.
  • Steuerberater müssen im deutschen Steuerberaterregister gelistet sein.
  • Unternehmen müssen im Handelsregister oder einem ähnlichen Register auffindbar sein.

Onboarding-Prozess​

1. Initialisierung​

POST /selfOnboarding

  • Übermittelt die gewünschten Berechtigungen und Mandantendaten.
  • Gibt einen Onboarding-Link sowie einen Public Access Token zurück.

2. Weiterleitung an den Kunden​

  • Der Kunde öffnet den erhaltenen Link.
  • Er überprüft die angeforderten Rechte und beginnt mit dem Setup.

3. Rollenwahl und Identifikation​

  • Der Kunde wählt seine Rolle (Steuerberater, Unternehmen, Mandant eines Steuerberaters).
  • Die Identitätsprüfung erfolgt entweder mit einer DATEV Smart Card oder einem offiziellen Identitätsnachweis.

4. IT-Partner-Details angeben​

  • Falls vorhanden, gibt der Kunde IT-Partner-Informationen an (Name, E-Mail, Telefon).

5. Vertragsunterzeichnung​

  • Eine Zusammenfassung des Onboardings wird angezeigt.
  • Der Kunde signiert digital mit der DATEV Smart Card oder seinem Identitätsnachweis.

6. Aktivierung des Zugangs​

  • Sobald das Onboarding abgeschlossen ist, erhält der Kunde einen Benutzername-Passwort-Zugang.
  • Der Status kann über GET /selfOnboarding/status überprüft werden.
  • Falls der Status „activatedAccess“ erreicht, können die Anmeldedaten mit GET /selfOnboarding/credentials abgerufen werden.

Cloud Gateway Onboarding API

API-Endpunkte​

Authentifizierung​

Alle API-Anfragen erfordern eine Authentifizierung über einen Bearer Token. Diesen Token (API Key) findest du im Partnerportal.

Erforderliche Header für API-Requests:

HeaderWertBeschreibung
AuthorizationBearer <access_token>API Key aus dem Partnerportal
Content-Typeapplication/jsonGibt das Datenformat der Anfrage an
Hostapi.cloudgateway.riecken.ioAPI-Host

1. Abrufen der verfügbaren Rechte​

Request​

GET /availableRights
Host: api.cloudgateway.riecken.io
Authorization: Bearer <access_token>
  • Ermittelt die verfügbaren Berechtigungen für den Softwarepartner.
  • Wird benötigt, um im POST /selfOnboarding-Request die Rechte anzugeben.

Response​

[
  {
    "id": "123",
    "name": "Buchhaltungszugriff",
    "description": "Erlaubt Zugriff auf Buchhaltungsdaten",
    "apiType": "ONPREMISE",
    "apiProgramGroup": "ACCOUNTING",
    "apiOperation": "GET"
  }
]

2. Self-Onboarding starten​

Request​

POST /selfOnboarding
Host: api.cloudgateway.riecken.io
Content-Type: application/json
Authorization: Bearer <access_token>

Request-Body:

{
  "requestedClients": [
    { "consultantNumber": "*", "clientNumber": "10000-12000" }
  ],
  "requestedRights": ["123"]
}

Response​

{
  "publicAccessToken": "xyz123",
  "redirectUrl": "https://api.cloudgateway.riecken.io/onboarding/xyz123"
}

3. Onboarding-Status abrufen​

Request​

GET /selfOnboarding/status?onboardingPublicAccessToken=xyz123
Host: api.cloudgateway.riecken.io
Authorization: Bearer <access_token>
  • Prüft den aktuellen Status des Onboarding-Prozesses.
  • Statuswerte können pending, finished oder failed sein.

Response​

{
  "status": "pending",
  "detailedStatus": "userLoggedIn"
}

4. Zugangsdaten abrufen​

Request​

GET /selfOnboarding/credentials?onboardingPublicAccessToken=xyz123
Host: api.cloudgateway.riecken.io
Authorization: Bearer <access_token>
  • Abruf der generierten API-Zugangsdaten nach erfolgreichem Onboarding.
  • Zugangsdaten sind für einen Monat verfügbar.

Response​

{
  "username": "exampleUser",
  "password": "securePassword"
}