Zentriq Agent ist live auf Microsoft AppSourceKostenlos installieren →Microsoft AppSourceKostenlos installieren →

Was ist ein API Page (API-Seite) in Business Central?

Eine API Page ist ein Business Central Seitenobjekt vom Typ API, das eine Tabelle als JSON REST Endpunkt für Integrationen bereitstellt.

Eine API Page ist ein Business Central Seitenobjekt vom Typ API. Sie veröffentlicht eine Tabelle als JSON Endpunkt über OData v4, wobei Publisher, Gruppe, Version und Entitätsname die URL bilden. Die Standard APIs decken gängige Entitäten wie Debitoren, Kreditoren, Artikel und Rechnungen ab, eigene API Pages lassen sich in einer AL Erweiterung ergänzen.

API Pages öffnet kein Benutzer, sie werden von Anwendungen aufgerufen. In Business Central berechtigt eine Administratorin die aufrufende Anwendung: Suchen Sie mit Alt+Q die Seite mit den registrierten Microsoft Entra Anwendungen und weisen Sie ihr die nötigen Permission Sets zu. Als klassische Webdienste veröffentlichte Seiten stehen auf der Seite Web Services, eine von einer Erweiterung gelieferte API Page ist dagegen sofort nach der Installation verfügbar.

Eine Integration liest die Einkaufsrechnungen eines Mandanten. Sie meldet sich per OAuth an, ermittelt die Mandanten-ID und ruft dann den Standardendpunkt für Einkaufsrechnungen mit einem Filter auf die Kreditorennummer auf, zum Beispiel vendorNumber eq 'V10000'. Die Antwort ist JSON, ein Objekt pro Rechnung, mit den Feldern der API Page und einem etag Wert für spätere Aktualisierungen.

Häufige Fehler: ein Aufruf ohne Mandanten-ID, der nichts findet; eine Änderung ohne das etag des gelesenen Datensatzes, die der Dienst ablehnt, um fremde Änderungen nicht zu überschreiben; und das Erreichen der Anfragegrenzen bei Massenladungen, worauf eine Drosselungsantwort kommt, die der Aufrufer nach einer Pause wiederholen muss. In der Entwicklung gilt: Eine Entität umzubenennen oder ihre Version zu ändern, ändert die URL und bricht alle Konsumenten, veröffentlichte Namen bleiben deshalb fix.

APIs sind der unterstützte Weg, Business Central Daten von aussen zu lesen und zu schreiben, und der Zugriff bleibt durch die Berechtigungen des verwendeten Kontos begrenzt. Zentriq Agent und der Zentriq Connector für Claude und ChatGPT nutzen diese Ebene mit delegiertem Zugriff: Antworten umfassen nur Daten, die der angemeldete Benutzer lesen darf, und alles Erzeugte landet als Entwurf zur Freigabe in Business Central.

Häufige Fragen

Worin unterscheiden sich API Page und Webdienst?

Eine als Webdienst veröffentlichte Seite oder Codeunit wird über die OData oder SOAP URL angeboten, eine API Page ist ein eigener Seitentyp mit festem JSON Vertrag und eigenem api Pfad. Für neue Integrationen ist die API Page die empfohlene Variante.

Unter welchem Konto läuft ein API Aufruf?

Entweder unter einem angemeldeten Benutzer mit delegiertem Zugriff oder unter einer registrierten Anwendung. Beide müssen in Business Central berechtigt sein und passende Permission Sets erhalten, bevor Daten zurückkommen.

Verwandte Begriffe

  • AL-Erweiterung (Business-Central-App), Eine massgeschneiderte Anwendung, die in der Programmiersprache AL entwickelt wird und die Funktionalität von Business Central erweitert.
  • Delegierter OAuth-2.0-Zugriff, Eine Authentifizierungsmethode, bei der eine Drittanbieteranwendung im Namen eines Benutzers handelt und dessen Berechtigungen übernimmt, ohne Anmeldedaten zu speichern.
  • Permission Set (Berechtigungssatz), Ein Permission Set bündelt Lese-, Einfüge-, Änderungs- und Löschrechte auf Business Central Objekte und wird Benutzern zugewiesen.
  • E-Beleg (E-Document), Das Framework von Business Central zum Senden und Empfangen strukturierter elektronischer Rechnungen in Formaten wie PEPPOL BIS, XRechnung und Factur-X.
  • Job Queue Entry (Aufgabenwarteschlangenposten), Ein Job Queue Entry plant einen Bericht oder eine Codeunit, die Business Central im Hintergrund einmalig oder wiederkehrend ausführt.

Wie Zentriq hilft

Die KI-Tools von Zentriq automatisieren viele der manuellen Prozesse rund um api page (api-seite) in Business Central. Mehr über den Zentriq Agent erfahren oder Zentriq PunchOut ausprobieren um zu sehen, wie KI den Einkauf in BC vereinfacht.

Verwandte Ressourcen

GlossarAL-Erweiterung (Business-Central-App)GlossarDelegierter OAuth-2.0-Zugriff