Migrating existing API integrations - General information

DATEV has started to put the infrastructure for a new API management into operation. Since this involves several breaking changes and an automatic migration of existing integrations is not possible, we have compiled all information and support offers for existing API integrations on this page.
 

General Information

  • Migrating integrations to the new API gateway can be difficult for online APIs.
    • in the Accounting and Human Resource area as of 04/03/2023start
    • in the My Tax area we will contact you and provide additonal information
    • in the area Cash Register we will contact you and provide additonal information
       
  • All migrations must be by 31.03.2024 completed & by DATEV accepted From the 01.04.2024 only the new API gateway will be available. Integrations on the old API gateway will no longer work from that date.
     
  • We have compiled the most important changes on the following page:
    Migration to new API management - Changes
     

Process & Support

As a DATEV partner, you can start the 03.04.2023 migration.

IMPORTANT: DATEV now also offers all other software companies (i.e. non-partners) the possibility to connect the DATEV data services via the new API gateway. For these software companies, DATEV has created a new registration form for API integration and linked it in various places in the DATEV Developer Portal. As a DATEV Marktplatz-Partner, no registration is required for you!

As a partner, the migration process looks as follows:

  1. Self-study of the information provided:
    Derive the necessary adjustments in their integration based on the following changes in DATEV:
  2. Initial consultation on migration:
    We create your API client together with you in the Developer Portal and configure it appropriately for your API integration. The DATEV consultant will then give you an up-to-date overview of what you need to pay attention to during the migration. Finally, your individual questions can still be clarified.
    To book the initial consultation (Duration: 1 hour, free of charge)
     
  3. Implementation of all relevant changes:
    You implement the relevant changes in your API integration. If needed, you can book additional consulting
     
  4. Book appointment(s) for technical review(s):
    After the initial consultation, they will receive a summary from DATEV of which technical reviews are still required for them. Note that at least the technical reviews production based on the new API Gateway and the updated DATEV interface requirements is to be repeated.
     
  5. Convert integration to new API gateway by 03/31/2024 :
    After you've received the approval for production, you can start moving your customers to the new integration. Note in particular that all customers to be moved must also issue new tokens for your software.

Migration to new API management - Changes

Breaking Changes

  • New Client-ID & Client-Secret incl. token-reset

    You have to create your own, new API client via self-service in the DATEV Developer Portal. This API-Client works exclusively with the new API-Gateway and replaces your old credentials (Client-ID + Client-Secret)

    Important remark regarding long-term-tokens: Every user has to re-authenticate (login) to use a DATEV Datenservice. Re-registration and configuration are not required.

     

  • New URL scheme

    The URL scheme for all online APIs changes. Instead of https://(sandbox-)api.datev.de/<api-domain>/<version>... as before, the URL scheme is https://<api-domain>.api.datev.de/platform(-sandbox)/<version>...

     

  • New Default-Header

    The header parameter "X-Datev-Client-Id" is mandatory. Your new Client-ID (see above) must be send as the value.

 

Non-Breaking Changes

  • New rate limit

    The old rate limit was linked to individual access tokens (500 requests per minute per token for all APIs). In the new gateway, the rate limit is linked to the API client and its subscribed online APIs. Thus, an API client can also have different rate limits per online API and this across all users of the API client. This changed logic may lead to necessary adjustments in your API integration.

     

  • YAML specification based validation

    Our new API gateway automatically performs validation on incoming APIs calls based on the published YAML files. This was not consistently the case with our old infrastructure which is why the behavior of the actual API in the backend and the API in the frontend (YAML) could differ. So under certain circumstances it is to be expected that the previous code does not work despite taking into account all the changes. In this case, the new YAML file should be checked again in detail.

     

  • Efficiency of your API integration

    The new API gateway will also be the basis for a usage-based billing towards software providers. Therefore you should check whether the call behavior of your Online-API integration is economical. DATEV has currently not planned a concrete date or timeline for the roll-out of usage-based billing towards software providers however.