Standard-Web-API

Hinweis

In diesen Versionshinweisen werden Funktionen beschrieben, die unter Umständen noch nicht veröffentlicht worden sind. Wann die Veröffentlichung dieser Funktionen geplant ist, erfahren Sie unter Neuerungen und geplante Funktionen für Dynamics 365 Business Central. Die Zeitpläne für die Veröffentlichung und die geplanten Funktionen ändern sich möglicherweise oder erfolgen möglicherweise nicht (weitere Informationen finden Sie in der Microsoft-Richtlinie).

Die Standard-Web-API verlässt die Betaphase. Die API wurde in der Betaphase basierend auf dem Feedback der Partnercommunity weiterentwickelt. Diese Version integriert finale Verbesserungen und mehrere neue Entitäten in der API als Version 1.0.

Verbesserungen für Entwickler

  • Entwicklung von APIs in AL mithilfe benutzerdefinierter Namespaces
  • offene API-Spezifikation 3.x

Änderungen von der Betaversion zu APIs der Version 1.0

  • tiefe Schachtelung von Entitäten
  • einfache Schlüssel
  • API zur Erfassung der Arbeitszeitnachweise von Mitarbeitern

Geschäftswert

Die Standard-Web-API stellt mehr als 48 Entitäten bereit und ermöglicht lose gekoppelte Integrationen in Business Central. Wenn Sie die Web-API verwenden, ist keine Entwicklung oder Bereitstellung innerhalb von Business Central notwendig. Zu den wichtigsten Designzielen gehörten die Bereitstellung von APIs, für die keine umfassenden Kenntnisse von Business Central erforderlich ist, sowie die Bereitstellung eines Vertrags mit fester Version, der eine standardisierte Integrationsmöglichkeit zwischen Lokalisierungen und Bereitstellungen von Business Central ermöglicht.

Die Standard-API ist in Business Central online standardmäßig aktiviert und kann auch für lokale Bereitstellungen aktiviert werden.

APIs in AL entwickeln

Erweiterungen können APIs verfügbar machen, die die API-Plattform in Business Central nutzen. Dies bedeutet, dass benutzerdefinierte APIs dieselben Funktionen wie die Standard-APIs haben. Dies umfasst die Unterstützung für Webhooks, OAS 3.0, OData v4 und die Versionsverwaltung.

Die Entwicklung von APIs nutzt benutzerdefinierte Namespaces – eine Möglichkeit, APIs in Gruppen zu unterteilen. Dies erfordert, dass die API die Eigenschaften APIPublisher, APIGroup und APIVersion angibt.

page 50100 ApiPageExpenses
{
    PageType = API;
    Caption = 'apiPageName';
    APIPublisher = 'contoso';
    APIGroup = 'expenses';
    APIVersion = 'v2.0';
    EntityName = 'Receipt';
    EntitySetName = 'Receipts';
    SourceTable = ContosoReceipt;
    InsertAllowed = true;
    DeleteAllowed = true;
    layout
    {
        area(Content)

Zur Zeit der Bereitstellung führt das oben gezeigte Beispiel dazu, dass Routingtabellen aktualisiert werden. Dadurch wird der Endpunkt im angegebenen Namespace verfügbar gemacht.

GET https://api.businesscentral.dynamics.com/v1.0/api/contoso/expenses/v2.0/companies(7d0b2f2d-150e-4596-b064-e66f3491811c)/Receipts

offene API-Spezifikation 3.x

Business Central unterstützt Sie bei der OAS 3.0-Generierung. OAS stellt ein allgemeines Metadatenformat bereit, aus dem SDKs für die meisten Programmiersprachen generiert werden können.

Nach April 2019 wird die Business Central API-Dokumentation auch über OAS generiert.

Tiefere Schachtelung von Entitäten

Aufgrund von Einschränkungen in Teilseiten ist es nicht möglich, eine Entitätsstruktur zu haben, die tiefer als zwei Ebenen ist. Beispiel:

/journal({id})/journalLine(id)

Diese Einschränkung für dieses spezielle Beispiel macht die Verwendung von attachments zu journalLines umständlich, da es keine Möglichkeit gibt, die Ressource direkt anzusprechen:

/journal({id})/journalLine(id)/attachment(id)

Bei aktuellen Betaimplementierungen ist attachments im Stamm enthalten.

Einfache Schlüssel

Mehrteilige/komplexe Schlüssel erschweren die Verwendung der APIs, da das Erstellen von Anforderungen mehrere Parameter erfordern kann. Bis April 2019 werden APIs einfache Schlüssel verwenden.

API zur Erfassung der Arbeitszeitnachweise von Mitarbeitern

Arbeitsnachweise von Mitarbeitern werden über die Standard-API ermöglicht. Arbeitszeitnachweise in Business Central unterstützen derzeit die Zeitregistrierung der Mitarbeiter mit Ressourcen. Bei der aktuellen Implementierung kann eine Ressource mehrere Maschinen und Personen darstellen. Bis April 2019 muss die Ressource, auf der die Arbeitszeitnachweise erfasst werden, auf einen Mitarbeiter verweisen.

Anwender

Endbenutzer, Administratoren, Anpasser, entwickelnde Anwender, Entwickler

Status

Derzeit sind alle APIs in der Betaphase. Bis April 2019 werden APIs der Version 1.0 veröffentlicht, die die oben beschriebenen Verbesserungen enthalten.

Verfügbarkeit

SaaS, lokal

Teilen Sie uns Ihre Meinung mit.

Helfen Sie uns dabei, Dynamics 365 Business Central zu verbessern, indem Sie Ideen erläutern, Vorschläge machen und Feedback geben. Verwenden Sie das Business Central-Forum unter https://aka.ms/businesscentralideas.