
Was sind API-Seiten in Microsoft Dynamics 365 Business Central?
Microsoft Dynamics 365 Business Central bietet ein leistungsstarkes API-Framework, das eine nahtlose Integration mit anderen Systemen und Anwendungen ermöglicht. Daten aus API-Seiten in Business Central zu lesen, ist eine häufige Anforderung für Unternehmen, die Prozesse automatisieren, Daten konsolidieren oder Business Central mit Anwendungen von Drittanbietern verbinden möchten. Dieser Artikel erklärt ausführlich, was API-Seiten in Business Central sind und wie Sie mit ihnen arbeiten.
Zusammenfassung
Dieser umfassende Leitfaden erklärt, wie Sie API-Seiten von Microsoft Dynamics 365 Business Central lesen und in Integrationen nutzen. Sie erfahren mehr über die API-Authentifizierung mit OAuth 2.0, die Struktur der Endpunkte (/api/v2.0/), GET-Anfragen zum Abrufen von Daten, das Filtern mit OData-Parametern und Best Practices für eine sichere Integration. Erfahren Sie, warum API-Seiten den älteren OData-Endpunkten bei ERP-Integrationen überlegen sind, informieren Sie sich über Ratenlimits und Berechtigungen und sehen Sie, wie Integrationsplattformen wie Rapidi die Anbindung an die Business Central API vereinfachen. Mit ausführlichen FAQ zur Einrichtung der Authentifizierung, zum Erstellen eigener APIs, zur Behebung häufiger Fehler und zu Batch-Vorgängen.
Inhaltsverzeichnis
- Was sind API-Seiten in Business Central?
- Welche Vorteile bieten API-Seiten in Business Central?
- Warum API-Seiten statt OData-Seiten in Business Central?
- Wie steigen Sie in die Business Central APIs ein?
- So lesen Sie Daten aus API-Seiten
- Welche Best Practices gelten für das Lesen von API-Seiten?
- Typische Anwendungsfälle für das Lesen von API-Seiten
- Wie integrieren Sie Business Central API-Seiten mit Rapidi?
- Fazit
- FAQ
Was sind API-Seiten in Business Central?
API-Seiten sind eine Art von Webservice-Endpunkten in Business Central, über die externe Systeme mit den in der Anwendung gespeicherten Daten interagieren können. Diese Seiten stellen Business Central-Daten in einem strukturierten Format bereit, in der Regel als JSON, und erleichtern so die Integration mit anderen Anwendungen über HTTP-Anfragen.
API-Seiten in Business Central unterscheiden sich von Standardseiten, da sie für den programmgesteuerten Zugriff und nicht für die Bedienung durch Benutzer konzipiert sind.
Welche Vorteile bieten API-Seiten in Business Central?
API-Seiten in Business Central bieten mehrere Vorteile, die sie für Unternehmen zu einem unverzichtbaren Werkzeug machen:
- Standardisierter Zugriff: Sie bieten einen einheitlichen und zuverlässigen Zugriff auf Business Central-Daten nach REST-Prinzipien, was die Integration mit modernen Anwendungen und Systemen vereinfacht.
- Echtzeitdaten: API-Seiten ermöglichen den Zugriff auf Business Central-Daten in Echtzeit, sodass verbundene Anwendungen stets über die aktuellsten Informationen verfügen.
- Anpassbar und erweiterbar: Entwickler können eigene API-Seiten erstellen, die auf spezifische Geschäftsanforderungen zugeschnitten sind, und gewinnen so Flexibilität und Skalierbarkeit.
- OData-Unterstützung: Mit OData-Abfrageparametern lassen sich Daten filtern, sortieren und seitenweise abrufen, was den Datenabruf effizient und leistungsoptimiert macht.
- Plattformübergreifende Kompatibilität: Business Central APIs lassen sich mit einer Vielzahl von Programmiersprachen und Tools nutzen und ermöglichen so die Integration mit Cloud-Diensten, mobilen Apps und Desktop-Lösungen.
- Sichere Kommunikation: Die APIs unterstützen OAuth 2.0-Authentifizierung und HTTPS-Protokolle und gewährleisten so einen sicheren Zugriff auf sensible Daten.
Diese Vorteile machen API-Seiten zur idealen Wahl für Unternehmen, die ihre Konnektivität verbessern, Abläufe optimieren und fundiertere datenbasierte Entscheidungen treffen möchten.
Warum API-Seiten statt OData-Seiten in Business Central?
Sowohl API-Seiten als auch OData-Seiten dienen in Business Central als Webservice-Endpunkte, doch API-Seiten bieten gegenüber OData-Seiten klare Vorteile:
- Speziell für die Integration entwickelt: API-Seiten sind ausdrücklich für den programmgesteuerten Zugriff und die Integration zwischen Systemen konzipiert. Sie stellen nur die wesentlichen Felder und Funktionen bereit, was die Komplexität reduziert und die Leistung steigert.
- Bessere Leistung: API-Seiten sind schlanker und für Integrationsszenarien besser optimiert als OData-Seiten, die aufgrund ihres breiteren Umfangs und ihrer größeren Flexibilität zusätzlichen Overhead verursachen können.
- Versionierung und Erweiterbarkeit: Das API-Framework von Business Central unterstützt Versionierung, sodass Entwickler bei Aktualisierungen die Abwärtskompatibilität wahren können. Bei OData-Diensten ist diese Funktion weniger ausgereift.
- Konsistenz über Umgebungen hinweg: API-Seiten bieten eine einheitliche und vorhersehbare Struktur und eignen sich daher besser für moderne Entwicklungspraktiken und Tools, die RESTful APIs erwarten.
- Integrierte Authentifizierung und Sicherheit: API-Seiten nutzen OAuth 2.0 und entsprechen modernen Sicherheitsstandards besser als herkömmliche OData-Endpunkte, die für ein vergleichbares Sicherheitsniveau unter Umständen zusätzliche Konfiguration erfordern.
- Kompatibilität mit dem Ökosystem: Viele Tools von Drittanbietern, Middleware-Lösungen und Integrationsplattformen sind für REST APIs optimiert, wodurch API-Seiten besser mit externen Systemen kompatibel sind.
Für Unternehmen, bei denen Integrationen, Skalierbarkeit und Leistung im Vordergrund stehen, sind API-Seiten in der Regel die bessere Wahl gegenüber OData-Seiten.
Wie steigen Sie in die Business Central APIs ein?
1. API-Zugriff einrichten
Bevor Sie auf API-Seiten zugreifen, stellen Sie sicher, dass die folgenden Voraussetzungen erfüllt sind:
- Authentifizierung: Richten Sie die OAuth 2.0-Authentifizierung für einen sicheren API-Zugriff ein. Dafür wird häufig Azure Active Directory (AAD) verwendet.
- Benutzerberechtigungen: Stellen Sie sicher, dass der Benutzer, der auf die API zugreift, über die entsprechenden Berechtigungen verfügt. Weisen Sie in Business Central die erforderlichen Rollen zu, um Zugriff auf die Daten zu gewähren.
Struktur der API-URL:
Business Central stellt zwei Haupttypen von Endpunkten bereit:
- OData-Endpunkte (Legacy) unter
/ODataV4/ - Moderne Business Central API-Endpunkte unter
/api/v2.0/
Die empfohlene Struktur für die API-Seiten von Business Central lautet:
https://api.businesscentral.dynamics.com/v2.0/<tenant_id>/<environment_name>/api/v2.0/
Beispiel – Mandanten abrufen:
https://api.businesscentral.dynamics.com/v2.0/<tenant_id>/<environment_name>/api/v2.0/companies
Der Pfad /api/v2.0/ ist versioniert und für Integrationen optimiert, während /ODataV4/ für OData-Webservices verwendet wird, die in Business Central erstellt wurden.
2. API-Seiten erkunden
Microsoft stellt eine Vielzahl vordefinierter API-Seiten bereit, die Sie direkt nutzen können. Beispiele:
- Companies: Ruft Details zu den Mandanten in Business Central ab.
- Customers: Ruft Debitoreninformationen ab.
- Items: Liefert Details zu Lagerartikeln.
Verfügbare APIs ermitteln
Um alle verfügbaren API-Seiten in Ihrer Umgebung aufzulisten, können Sie eine GET-Anfrage an folgende Adresse senden:
https://api.businesscentral.dynamics.com/v2.0/<tenant_id>/<environment_name>/api/v2.0/
Sie erhalten einen Katalog aller veröffentlichten API-Endpunkte, einschließlich ihrer Entitätsnamen und Versionsnummern.
Weitere Informationen finden Sie in der Business Central API-Dokumentation von Microsoft.
So lesen Sie Daten aus API-Seiten
Daten aus einer API-Seite zu lesen, ist einfacher, als Sie denken: Sie müssen lediglich eine HTTP-GET-Anfrage senden. Das Verfahren ist unkompliziert, und Sie werden schnell damit vertraut sein. Beachten Sie jedoch: Mit Rapidi müssen Sie HTTP-Anfragen nicht manuell verarbeiten – die Anbindung an API-Seiten ist bereits integriert. Geben Sie in der Einrichtung Ihrer Rapidi-Verbindung die richtige Endpunkt-URL an, und Rapidi liest und verarbeitet die Daten aus der Business Central API automatisch.
1. GET-Anfrage senden
Um Daten aus einer API-Seite zu lesen, verwenden Sie eine HTTP-GET-Anfrage.
Beispielanfrage:
https://api.businesscentral.dynamics.com/v2.0/<tenant_id>/<environment>/api/v2.0/companies
Antwort:
{
"value": [
{
"id": "12345678-1234-1234-1234-1234567890ab",
"name": "Cronus International Ltd.",
"address": "1234 Main St",
"city": "London",
"country": "UK"
}
]
}
2. Daten filtern und abfragen
Die Business Central APIs sind so konzipiert, dass Sie die Kontrolle behalten. Sie unterstützen OData-Abfrageparameter vollständig, sodass Sie Daten nach Bedarf filtern, sortieren und seitenweise abrufen können.
Beispiel mit Filter:
https://api.businesscentral.dynamics.com/v2.0/<tenant_id>/<environment>/api/v2.0/customers?$filter=displayName eq 'CRONUS International Ltd.'
Welche Best Practices gelten für das Lesen von API-Seiten?
- APIs absichern: Verwenden Sie immer HTTPS und geeignete Authentifizierungsmethoden wie OAuth 2.0, um API-Endpunkte abzusichern. So sind Ihre Daten jederzeit sicher und geschützt.
- Abfragen optimieren: Verwenden Sie OData-Abfrageparameter wie
$filter,$selectund$top, um die zurückgegebenen Daten zu begrenzen und die Größe der Nutzdaten zu verringern. - Drosselung berücksichtigen: Business Central begrenzt die Anzahl der API-Anfragen. Wenn Sie die Antwort 429 Too Many Requests erhalten, implementieren Sie Wiederholungsversuche mit exponentiellem Backoff.
- API-Nutzung überwachen: Überwachen Sie die API-Nutzung regelmäßig, um sicherzustellen, dass sie Ihrer Business Central-Lizenzierung entspricht und die Limits nicht überschreitet.
Typische Anwendungsfälle für das Lesen von API-Seiten
- Datenintegration: Synchronisieren Sie Business Central-Daten mit anderen ERP-Systemen, CRM-Systemen oder individuellen Anwendungen.
- Reporting: Extrahieren Sie Daten für externe Reporting-Tools wie Power BI oder Tableau.
- Automatisierung: Automatisieren Sie Workflows, indem Sie Echtzeitdaten aus Business Central abrufen.
Wie integrieren Sie Business Central API-Seiten mit Rapidi?
Rapidi ist vollständig kompatibel mit den API-Seiten von Business Central, sodass Unternehmen Business Central mit anderen Systemen wie Salesforce, HubSpot oder Legacy-ERP-Systemen verbinden können.
Anders als ältere OData-Webservices sind API-Seiten in Business Central REST-basiert und schlank und damit ideal für Integrationen mit hohem Datenvolumen und in Echtzeit.
Rapidi kann Daten direkt über diese API-Endpunkte lesen und schreiben und beherrscht dabei Funktionen wie Filterung, Paginierung und Delta-Logik.
Diese Kompatibilität ermöglicht die nahtlose Synchronisierung von Tabellen oder Datenentitäten wie Debitoren, Artikeln oder Verkaufsaufträgen – bei gleichbleibender Sicherheit und Leistung.
Fazit
Das Lesen von API-Seiten in Business Central ist eine wichtige Fähigkeit für Unternehmen, die ihr ERP-System voll ausschöpfen möchten. Mit der richtigen Einrichtung und bewährten Vorgehensweisen können Sie effizient auf Ihre Daten in Business Central zugreifen und das Beste aus ihnen herausholen, um Integrationen, Reporting und Automatisierung voranzutreiben.
Aktualisiert im Januar 2026
Häufig gestellte Fragen (FAQ)
Authentifizierung & Einrichtung
Wie richte ich die OAuth 2.0-Authentifizierung für Business Central APIs ein?
Sie registrieren eine Anwendung im Azure-Portal, konfigurieren die API-Berechtigungen (Dynamics 365 Business Central mit delegierten Berechtigungen oder Anwendungsberechtigungen), erstellen einen geheimen Clientschlüssel, richten Umleitungs-URIs ein und registrieren die Azure AD-Anwendung anschließend in Business Central auf der Seite „Azure Active Directory Applications“ mit den entsprechenden Benutzerberechtigungen.
Was ist der Unterschied zwischen delegierten OAuth 2.0-Berechtigungen und Anwendungsberechtigungen (Service-to-Service)?
Delegierte Berechtigungen erfordern eine Interaktion und Zustimmung des Benutzers und eignen sich für Szenarien, in denen im Namen eines Benutzers gehandelt wird. Die Service-to-Service-Authentifizierung (S2S) nutzt den Client-Credentials-Flow für unbeaufsichtigte Integrationen ohne Benutzerinteraktion und ist ideal für automatisierte Systemintegrationen.
Kann ich für Business Central Online weiterhin Webdienst-Zugriffsschlüssel (Basic Auth) verwenden?
Nein. Webdienst-Zugriffsschlüssel sind für Business Central Online seit dem Veröffentlichungszyklus 1 von 2022 (BC20) veraltet. Für jeden API-Zugriff müssen Sie die OAuth 2.0-Authentifizierung verwenden.
Welche Berechtigungen muss ich zuweisen, um auf APIs zuzugreifen?
Den Berechtigungssatz SUPER können Sie API-Benutzern nicht zuweisen. Gängige Berechtigungssätze sind je nach Bedarf D365 FULL ACCESS, D365 BUS FULL ACCESS oder D365 BASIC. Wenden Sie in der Produktion das Prinzip der geringsten Rechte an und weisen Sie nur die Berechtigungen zu, die für die jeweiligen Vorgänge erforderlich sind.
API-Endpunkte & Struktur
Was ist der Unterschied zwischen den Endpunkten /api/v2.0/ und /ODataV4/?
/api/v2.0/ ist die moderne, versionierte Business Central API, die für Integrationen optimiert ist und bessere Leistung und Standardisierung bietet. /ODataV4/ wird für OData-Webservices verwendet und gilt als Legacy. Verwenden Sie für neue Integrationen immer /api/v2.0/.
Wie finde ich alle verfügbaren API-Endpunkte in meiner Business Central-Umgebung?
Senden Sie eine GET-Anfrage an https://api.businesscentral.dynamics.com/v2.0/<tenant_id>/<environment>/api/v2.0/, um einen Katalog aller veröffentlichten Endpunkte zu erhalten. Mit der Option $metadata können Sie außerdem detaillierte XML-Schemainformationen zu den verfügbaren Entitäten und ihren Eigenschaften abrufen.
Filtern & Abfragen
Wie filtere ich API-Ergebnisse?
Verwenden Sie den OData-Abfrageparameter $filter. Beispiel: customers?$filter=displayName eq 'CRONUS International Ltd.'. Sie können Operatoren wie eq (gleich), ne (ungleich), gt (größer als), lt (kleiner als), and und or verwenden.
Fehlerbehandlung & Ratenlimits
Welche API-Ratenlimits gelten für Business Central?
Die aktuellen Limits liegen bei etwa 300 API-Anfragen pro Minute für Sandbox-Umgebungen und 600 pro Minute für Produktionsumgebungen. Außerdem gilt ein Limit von 100 gleichzeitigen OData-/SOAP-Anfragen und ein Timeout von 10 Minuten für einzelne Anfragen. Diese Limits gelten pro Benutzer.
Benutzerdefinierte APIs
Kann ich Standard-APIs von Business Central erweitern oder ändern?
Nein, Standard-API-Seiten lassen sich nicht direkt erweitern. Sie können jedoch den Quellcode der Standard-API aus dem GitHub-Repository ALAppExtensions von Microsoft kopieren und damit eine eigene, angepasste API-Seite erstellen.
Wie erstelle ich eine benutzerdefinierte API-Seite?
Erstellen Sie eine AL-Erweiterung mit PageType = API und geben Sie die Eigenschaften APIPublisher, APIGroup, APIVersion, EntityName und EntitySetName an. Als Best Practice verwenden Sie SystemId als ODataKeyFields. Die API ist anschließend erreichbar unter: https://api.businesscentral.dynamics.com/v2.0/<tenant>/<environment>/api/<publisher>/<group>/<version>/<entitySetName>
Was ist der Unterschied zwischen API-Seiten und API-Abfragen?
API-Seiten unterstützen vollständige CRUD-Vorgänge (Erstellen, Lesen, Aktualisieren, Löschen), während API-Abfragen schreibgeschützt sind, dafür aber eine bessere Leistung bieten. Abfragen können problemlos mehrere Tabellen verknüpfen, ohne $expand zu benötigen, und geben alles als einen einzigen Datensatz zurück.
Fehlerbehebung
Warum erhalte ich die Fehlermeldung „Access is denied to company“?
Das deutet in der Regel auf fehlende Berechtigungen hin. Prüfen Sie, ob Ihrer Azure AD-Anwendung in Business Central die richtigen Benutzergruppen und Berechtigungssätze zugewiesen sind, und kontrollieren Sie, ob der Mandantenname in Ihrer URL korrekt ist.
Warum gibt mein API-Aufruf leere oder fehlende Felder zurück?
Einige Eigenschaften in API v2.0 sind Navigationseigenschaften, die ausdrücklich mit $expand angefordert werden müssen. Prüfen Sie in der API-Dokumentation oder in $metadata, welche Felder erweitert werden müssen.
Wie führe ich Batch-Vorgänge aus oder füge mehrere Datensätze auf einmal ein?
Business Central unterstützt OData-Batch-Anfragen, mit denen sich mehrere Vorgänge in einem einzigen HTTP-Aufruf ausführen lassen. Ein einzelner POST fügt einen Datensatz ein; für mehrere Datensätze verwenden Sie Batch-Anfragen mit korrekt formatiertem JSON. Weitere Informationen finden Sie in der Microsoft-Dokumentation zu OData-Batch-Vorgängen.