Customer onboarding

Documentation (English)

For the German version, please scroll down to “Dokumentation (Deutsch)”

A customer or another type of user is interested in using Enterprise API. What’s to do?

Important:

In any customer/user contact, the DKV Customer Service is the primary point of contact. The API Access cannot be requested via the API Portal.

Prospective API user is not a DKV customer yet

If the prospective API user is not a DKV customer yet, the user should get in touch with DKV Sales Team or DKV Customer serivce, to become a DKV customer, by signing all relevant documents and especially the general terms and conditions related to the usage of our services.

API onboarding process

  1. Request Submission: The customer initiates the process by contacting customer service.

  2. Service Request Creation: Customer service opens a service request for the API onboarding.

  3. Credentials Issuance (7-10 Days):

It typically takes 7-10 days for the customer to receive their API credentials. A new created technical user, client id and his subscription key is sent via email, and the client secret is delivered via SMS.

The onboarding email also includes:

This information helps customers understand how to correctly authenticate and structure their API requests.

What kind of information is required for the onboarding?

Customer must provide to the DKV Customer service following information:

Is it possible to modify attributes of an existing technical user?

The attributes of every existing technical user can be changed, excepted technical user name itself.

The request for this can be made via DKV Customer Service, please use the technical username (NOT the clientId) as reference for requesting any change.

Can additional customer numbers be assigned to an existing technical user?

Additional customer numbers can also be assigned to existing technical user.

The request for this can made via DKV Customer Service, please use the technical username (NOT the clientId) as reference for requesting any change.

Are all services in the Enterprise API available to every customer?

The following services are available currently for free use, which shall however change in 2025:

Important: A service for delivering of online authorization data (OLA service) is not automatically accessible to all users.

Access is granted based on specific authorization processes and requirements.

Why is the OLA data not available for every customer?

Using of the OLA service requires special approval of the DKV Sales Lead.

DKV Customer Service is the primary point of contact also in this case.

API first tests with TryIt feature

Once the credentials are received, the customer can use the Try It feature to test API functionality before full integration.

Information for customer service

The customer onboarding can be ordered in Matrix42:

Enterprise API Customer Connection

Dokumentation (Deutsch)

Hier finden Sie die deutsche Dokumentation.

Kundenanbindung (Onboarding)

Ein Kunde oder ein potenzieller Benutzer ist an der Nutzung der Enterprise API interessiert. Was ist zu tun?

Wichtig:

Bei jedem Kunden- oder Benutzerkontakt ist der DKV Kundenservice der primäre Ansprechpartner. Der API-Zugang kann nicht über das API-Portal angefordert werden.

Potenzieller API-Nutzer ist noch kein DKV-Kunde

Falls der potenzielle API-Nutzer noch kein DKV-Kunde ist, sollte er sich mit dem DKV-Vertriebsteam oder dem DKV-Kundenservice in Verbindung setzen, um DKV-Kunde zu werden.

Dazu ist es notwendig, alle relevanten Dokumente, insbesondere die allgemeinen Geschäftsbedingungen zur Nutzung unserer Dienste, zu unterzeichnen.

API-Onboarding-Prozess

Es dauert in der Regel 7-10 Tage, bis der Kunde seine API-Zugangsdaten erhält.

Ein neu erstellter technischer Benutzer, die Client-ID und der Subscription Key werden per E-Mail versandt, während das Client Secret per SMS übermittelt wird.

The onboarding E-Mail also includes:

Diese Informationen helfen den Kunden, zu verstehen, wie sie ihre API-Anfragen korrekt authentifizieren und strukturieren.

Welche Informationen sind für das Onboarding erforderlich?

Der Kunde muss dem DKV Kundenservice folgende Informationen bereitstellen:

Ist es möglich, Attribute eines bestehenden technischen Benutzers zu ändern?

Die Attribute jedes bestehenden technischen Benutzers können geändert werden, mit Ausnahme des technischen Benutzernamens selbst.

Die Anfrage hierfür kann über den DKV Kundenservice gestellt werden, bitte verwenden Sie den technischen Benutzernamen (NICHT die Client-ID) als Referenz, um Änderungen anzufordern.

Können zusätzliche Kundennummern einem bestehenden technischen Benutzer zugeordnet werden?

Zusätzliche Kundennummern können ebenfalls einem bestehenden technischen Benutzer zugeordnet werden.

Die Anfrage dafür kann über den DKV Kundenservice gestellt werden, bitte verwenden Sie den technischen Benutzernamen (NICHT die Client-ID) als Referenz, um Änderungen anzufordern.

Sind alle Services in der Enterprise API für jeden Kunden verfügbar?

Die folgenden Services sind derzeit kostenlos nutzbar, dies wird sich jedoch im Jahr 2025 ändern:

Wichtig: Ein Service zur Bereitstellung von Online-Autorisierungsdaten (OLA-Service) ist nicht automatisch für alle Nutzer zugänglich.

Der Zugang wird basierend auf spezifischen Autorisierungsprozessen und Anforderungen gewährt.

Warum sind die OLA-Daten nicht für jeden Kunden verfügbar?

Die Nutzung des OLA-Services erfordert eine spezielle Genehmigung durch den DKV-Vertriebsleiter.

Der DKV Kundenservice ist auch in diesem Fall der primäre Ansprechpartner.

Erste API-Tests mit der TryIt-Funktion

Sobald die Zugangsdaten vorliegen, kann der Kunde die Try It -Funktion nutzen, um die API-Funktionalität vor der vollständigen Integration zu testen.

Information für Kundenservice

Eine Anbindung (Onboarding) kann mit einem Service request in Matrix42 beantragt werden:

Enterprise API Kunden Anbindung