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
A 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.