Mit diesem Formular können Sie fehlende, unklare oder fehlerhafte Inhalte in der Dokumentation melden und Verbesserungsvorschläge machen. Ihr Feedback hilft uns, die Qualität und Vollständigkeit kontinuierlich zu verbessern.
Liste der API-Pages füllen, pflegen und verwenden
Mit der Installation der Web Portal Connection statten Sie Business Central auch mit einer neuen API aus, die exemplarisch für die Integration von Webshops zusammengestellt wurde. Sie ermöglicht einem Partnersystem bereits Zugriff auf viele Tabellen, die häufig für Shop-Integrationen genutzt werden. API-Pages werden nicht mehr - wie die bisherigen UI-Pages - in der Webdienste-Tabelle veröffentlicht, sondern sind bereits über ihren Page-Typ "API" als Endpunkt deklariert und verwendbar. Für UI-Pages können Sie den Webdienst, den ein Partner zum Abruf geänderter Daten verwenden soll, aus der Liste der Webdienste für die jeweils abonnierte Tabelle auswählen. Da in dieser Liste keine API-Pages vorhanden sind, können Sie hierfür eine separate Liste pflegen. Diese Liste stellt eine Verknüpfung der programmierten API-Pages (ggf. je Gruppe (= Partner) und Version) mit den zugehörigen Tabellen und Entity-Namen bereit. Sie kann - ähnlich wie bisher die Liste der Webdienste - in der Universal Data Connection die tatsächliche Zuordnung erleichtern zwischen einer von einem Partner abonnierten Tabelle und dem API-Endpunkt, über die der Partner die geänderten Datensätze abrufen soll.
Die WPC-API wird in einer aktuellen sowie ggf. mehreren vorangegangenen Versionen ausgeliefert. Die Versionierung wird genutzt, um einerseits neue Tabellen oder Felder zu berücksichtigen, andererseits aber auch Partnern während der Entwicklungsphase zu ermöglichen, noch auf die zuletzt verwendete Version zuzugreifen, auch wenn die neue bereits installiert ist. So lassen sich Update-Schritte von Business Central entkoppeln von den Update-Arbeiten an Partnersystemen. Spätestens für den Echtbetrieb sollte allerdings immer bereits eine individualisierte API implementiert sein und verwendet werden. Die mit der Web Portal Connection ausgelieferte API kann dafür eine Vorlage sein und einem Partner als Orientierung dienen, sie ist aber für den Echtbetrieb nicht vorgesehen. Ein wesentlicher Grund dafür ist, dass sich die API im späteren Verlauf nicht an individuelle Bedarfe - eines Partners oder des Betreibers - anpassen lässt. Dies ist nur in APIs möglich, die als Teil einer individuellen Extension erstellt wurden.
Die hier beschriebenen APIs dienen den Partnersystemen u. a. zur Datensynchronisation. Deshalb bietet die Web Portal Connection eine Funktion an, die in der Universal Data Connection die Zuordnung zwischen einer abonnierten Tabelle und dem zugehörigen API-Endpunkt bzw. Entity erleichtert. Hierfür können Sie aus der WPC-Einrichtung heraus die Liste der API-Pages aufrufen und über eine Funktion (Aktion) befüllen lassen.
Nachdem Sie die Befüllung der Tabelle ausgelöst haben, empfiehlt sich eine Bereinigung um nicht verwendete API-Versionen. Sie können die ungenutzten Einträge z. B. anhand ihrer API-Gruppe und Version filtern und dann manuell löschen. So stehen bei der Einrichtung abonnierter Tabellen in der Universal Data Connection keine ungenutzten APIs mehr zur Auswahl. Zur Verwendung eigener APIs können die maschinell erzeugten Einträge als Vorlagen für die neuen, individuellen Einträge dienen, die Sie nach demselben Muster manuell vornehmen können.