Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In dem Beispiel werden für alle Artikel die Felder no (Artikelnr.), description (Beschreibung), description2 (Beschreibung2), baseUnitOfMeasure (Basiseinheit) und unitPrice (VK-Preis) ausgegeben.

Technische Einrichtung

Aufbau der URL

Die URL besteht aus der Base-URL https://Webserver:OData-Port/Mittelschicht/api/nevaris/finance/v2.0/companies(ID des Mandanten) und dem jeweiligen Endpunkt aus der oben verlinkten Dokumentation. Die ID des Mandanten kann über die Seitenüberprüfung in der Mandantenübersicht oder alternativ über einen GET-Request des Endpunktes /companies (https://Webserver:OData-Port/Mittelschicht/api/nevaris/finance/v2.0/companies) ermittelt werden.

Authentifizierung

Webdienst-Zugriffsschlüssel

Zur Authentifizierung wird der Windows-Benutzername benötigt und anstelle des Passwortes ein Webdienst-Zugriffsschlüssel. Dieser ist in der Benutzerkarte zu finden und kann dort nur vom Benutzer selber eingesehen werden. Selbst ein Administrator kann den Webdienst-Zugriffsschlüssel nicht sehen. Sollte noch keiner vergeben worden sein, kann dies über den AssistEdit erfolgen. Zur Auswahl stehen dort die Optionen "Schlüssel läuft niemals ab" oder "Schlüsselablaufdatum". Aus Sicherheitsgründen ist ein Schlüsselablaufdatum empfohlen, d. h. dass nach dem Ablauf ein neuer Schlüssel generiert werden muss und dieser in den angebundenen Systemen aktualisiert werden muss.

OAuth 2.0

Alternativ zur Authentifizierung mit dem Webdienst-Zugriffsschlüssel gibt es ebenfalls die Möglichkeit sich über OAuth 2.0 zu authentifizieren. Für diese Authentifizierungsmethode werden unterschiedliche Werte benötigt, die im Folgenden beschrieben sind.

Access Token URLhttps://login.microsoftonline.com/Tenant ID/oauth2/v2.0/token
Client IDWählen Sie die Client ID (AIOAzureAppID) der Entra-Anwendung aus, die Sie angelegt haben (Einrichtung Azure AD-Anmeldung - ACS - Finance 2024.1#EntraIDOAuth2.0Anwendungen)
Client SecretTragen Sie den Geheimschlüssel (AIOAzureAppKeyValue) ein, den Sie bei der Einrichtung erhalten haben (Einrichtung Azure AD-Anmeldung - ACS - Finance 2024.1#ErläuterungdesSkriptes)
Scope

Der Scope setzt sich zusammen aus der Application ID URI der WebClient App-Registrierung, den Berechtigungen .default und offline_access:

Beispiel: api://XXXXXX-XXXXXX-XXXXX-XXXXX/.default offline_access
Die URI finden Sie in Ihrer AppProperties.json (Einrichtung Azure AD-Anmeldung - ACS - Finance 2024.1#ErläuterungdesSkriptes)

Weitere Informationen dazu finden Sie in der Hilfe von Business Central.

Postman-Collection

Postman ist ein Tool, mit dem APIs abgefragt werden können, um die entsprechenden Antworten einsehen zu können. Mit Hilfe von Postman können sogenannte Collections bereit gestellt werden. Diese kann jeder für sich importieren und somit die verfügbaren Endpunkte, nach der Einrichtung der unten beschriebenen Environment, abfragen. 

...