For the German version, please scroll down to “Dokumentation (Deutsch)”
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.
The Customer Onboarding is required to use the Enterprise API. This process ensures that each customer receives personalized and secure access to our API, allowing us to maintain high security standards.
To retrieve of DKV data by the Enterprise API, follow these steps:
More detailes about the onboarding process you find on our page Enterprise API Onboarding
These credentials are necessary for authentication your API requests.
Each API user requires a technical user to access the API.
A technical user is a unit used to manage an API access for every customer.
Some more detailed information about technical user you find on our onboarding page: Enterprise API Onboarding
Authentication is the process of verifying the identity of a user that wants to access the Enterpsise API. This ensures that only authorized users or systems can interact with your services.
Authentication involves the use of OAuth token.
Authorization defines what an authenticated user is allowed to do.
After identity verification, the system checks the permissions associated with that identity to determine which customer number(s) data can be retrieved for and whether use of the API is permitted for authorized transactions.
Each Entreprise API request follows a specific structure.
HTTP Method: POST
Endpoint (URL): Each API within Enterprise API has it’s own endpoint where the API can be accessed. Each endpoint corresponds to a particular resource.
The base URL remains the same https://api.dkv-mobility.com/e-api/, but the specific path changes depending on the API.
More detailed information about the Enterprise API requests can be found on our api page Enterprise APIs
Headers: Headers provide metadata about the request and are essential for authentication and content type.
Authorization: Includes OAuth token
Content-Type: Specifies the format of the data being sent or received (application/json).
Accept: Informs the server what format the client expects in the response (*/*)
Query Parameters: These parameters are used to filter, sort, and customize your request. Passed in the Endpoint to refine the request
Example: https://api.dkv-mobility.com/e-api/v2.0.0/transactions/tranactionDate?size=100&page=0&customerId=0000123456&endDate=2024-06-30&startDate=2024-06-01
Request Body
The request body is used for additional filtering of a requested data. Format: JSON.
Example for a POST request to filtering of only invoiced transactions:
{
"invoiceStatus": {
"in": [
"INVOICED"
]
}
}In our product Enterprise API, each API is assigned its own version number.
Version numbers help ensure that updates can be tracked and referenced easily.
Version Numbering: APIs are labeled with a version number that increments when significant changes are made .
Examples: v1.0.1, v2.0.0, v1.0
After sending the request, the API will respond with a response code and data in JSON format.
More detailed information about the Enterprise API response structure can be found on our api page Enterprise APIs
API response code indicates the status of a request made to a server and informs whether the request was successful or if there were any errors.
The code consists of a three-digit number and is divided into different categories:
2xx (Success): The request was successfully processed and data is returned.
4xx (Client Error): There was an issue with the request (e.g., incorrect parameters or missing authentication).
5xx (Server Error): The server encountered an issue processing the request.
More detailed information about error codes you find on our error handling page: Enterprise API Error handling
Transaction datetime values in all Enterprise API responses will be displayed in UTC format.
Hier finden Sie die deutsche Dokumentation.
Wichtig: Bei allen Kunden-/Nutzeranfragen ist der DKV Kundenservice der primäre Ansprechpartner. Der API-Zugang kann nicht über das API-Portal angefordert werden.
Eine Kundeanbindung(Onboarding) ist erforderlich, um die Enterprise API zu nutzen. Dieser Prozess stellt sicher, dass jeder Kunde personalisierten und sicheren Zugang zu unserer API erhält, wodurch wir hohe Sicherheitsstandards aufrechterhalten können.
Um DKV-Daten über die Enterprise API abzurufen, befolge diese Schritte:
Mehr Details zum Onboarding-Prozess findest du auf unserer Seite Enterprise API Kundenanbindung
Erhalte Zugangsdaten: Nach Abschluss des Onboardings wird dein technischer Benutzer mit allen deinen Attributen (wie Firmenname, E-Mail, Mobilnummer etc.) erstellt, und du erhältst deine Authentifizierungsdaten per E-Mail und SMS. Diese Zugangsdaten sind notwendig, um deine API-Anfragen zu authentifizieren.
Integration starten: Verwende deine Zugangsdaten zur Authentifizierung und beginne mit der Integration der Enterprise API in deine Systeme. Weitere Informationen findest du in unserer API-Dokumentation, die detaillierte Anweisungen zu Endpunkten und zur Nutzung enthält.
Each API user requires a technical user to access the API.
A technical user is a unit used to manage an API access for every customer.
Jeder API-Nutzer benötigt einen technischen Benutzer, um auf die API zuzugreifen.
Ein technischer Benutzer ist eine Einheit, die verwendet wird, um den API-Zugang für jeden Kunden zu verwalten.
Weitere Informationen zu technischen Benutzern findest du auf unserer Onboarding-Seite: Enterprise API Kundenanbindung
Authentifizierung ist der Prozess der Überprüfung der Identität eines Nutzers, der auf die Enterprise API zugreifen möchte. Dies stellt sicher, dass nur autorisierte Nutzer oder Systeme mit deinen Diensten interagieren können.
Die Authentifizierung erfolgt durch die Verwendung eines OAuth-Tokens.
Autorisierung definiert, was ein authentifizierter Nutzer tun darf.
Nach der Identitätsüberprüfung überprüft das System die Berechtigungen, die mit dieser Identität verknüpft sind, um festzustellen, Daten welcher Kunden abgerufen werden können und ob die Nutzung der API für autorisierte Transaktionen erlaubt ist.
Jede Anfrage an die Enterprise API folgt einer spezifischen Struktur.
HTTP Methode: POST
Endpoint (URL): Jede API innerhalb der Enterprise API hat ihren eigenen Endpunkt, über den auf die API zugegriffen werden kann. Jeder Endpunkt entspricht einer bestimmten Ressource.
Die Basis-URL bleibt https://api.dkv-mobility.com/e-api/, aber der spezifische Pfad ändert sich je nach API.
Mehr Informationen über die Enterprise API-Anfragen findest du auf unserer API-Seite Enterprise APIs
Header: Header liefern Metadaten über die Anfrage und sind essenziell für die Authentifizierung und den Inhaltstyp.
Authorization: Enthält das OAuth-Token
Content-Type: Gibt das Format der gesendeten oder empfangenen Daten an (application/json)
Accept: Informiert den Server darüber, welches Format der Client in der Antwort erwartet (*/*)
Abfrageparameter(Query Parameters): Diese Parameter werden verwendet, um deine Anfrage zu filtern, zu sortieren und anzupassen. Sie werden im Endpunkt übergeben, um die Anfrage zu verfeinern.
Beispiel: https://api.dkv-mobility.com/e-api/v2.0.0/transactions/tranactionDate?size=100&page=0&customerId=0000123456&endDate=2024-06-30&startDate=2024-06-01
Anfrage-Body
Der Anfrage-Body wird für zusätzliche Filterung der angeforderten Daten verwendet. Format: JSON
Example for a POST request to filtering of only invoiced transactions:
{
"invoiceStatus": {
"in": [
"INVOICED"
]
}
}In dem Produkt Enterprise API hat jede API ihre eigene Versionsnummer.
Versionsnummern helfen dabei, Updates leicht nachzuverfolgen und zu referenzieren.
Versionsnummerierung: APIs werden mit einer Versionsnummer versehen, die sich erhöht, wenn signifikante Änderungen vorgenommen werden.
Beispiele: v1.0.1, v2.0.0, v1.0
Nach dem Senden der Anfrage antwortet die API mit einem Antwortcode und Daten im JSON-Format.
Weitere Informationen zur Struktur der API-Antworten findest du auf unserer API-Seite Enterprise APIs
Antwortcode (response code)
Ein Antwortcode zeigt den Status einer Anfrage an einen Server an und informiert darüber, ob die Anfrage erfolgreich war oder ob Fehler aufgetreten sind.
Der Code besteht aus einer dreistelligen Zahl und ist in verschiedene Kategorien unterteilt:
2xx (Erfolg): Die Anfrage wurde erfolgreich verarbeitet und Daten werden zurückgegeben.
4xx (Client-Fehler): Es gab ein Problem mit der Anfrage (z. B. falsche Parameter oder fehlende Authentifizierung).
5xx (Server-Fehler): Der Server hatte ein Problem bei der Verarbeitung der Anfrage.
Weitere Informationen zu Fehlercodes findest du auf unserer Seite zur Fehlerbehandlung: Enterprise API Error handling
Datumsangaben zu Transaktionen in allen Antworten der Enterprise API werden im UTC-Format angezeigt.