Inhaltsverzeichnis

Einleitung

Übersicht

Advanced API Connections ist eine Erweiterung für Microsoft Dynamics 365 Business Central, entwickelt von der akquinet NEXT GmbH. Diese App ermöglicht die flexible und konfigurierbare Anbindung von externen API-Endpunkten direkt aus Business Central heraus, ohne dass dafür individueller Programmcode (AL) geschrieben werden muss. Die Lösung dient als zentraler Hub für die Verwaltung von Schnittstellen zu Drittsystemen. Sie bietet Funktionen zur Definition von Verbindungen, Authentifizierungsmethoden, Endpunkten und Parametern sowie ein umfassendes Logging zur Überwachung der Kommunikation.

Hauptfunktionen

  • Konfigurierbare Verbindungen: Einrichtung von API-Verbindungen mit Basis-URLs und spezifischen Authentifizierungsdaten.
  • Entitäten Aktualisierung: Einrichtung von Entitäten (Tabellen) die bei Erstellung oder Aktualisierung von Datensätzen an eine API gesendet werden.
  • Flexible Authentifizierung: Unterstützung gängiger Methoden wie Basic Auth, OAuth2 (Client Credentials), und API Keys.
  • Endpunkt-Management: Definition spezifischer API-Ressourcen (Endpoints) mit HTTP-Methoden (GET, POST, PUT, DELETE, etc.).
  • Parameter-Steuerung: Dynamische Verwaltung von Header-, URL-, Query- und Body-Parametern.
  • Protokollierung: Detaillierte Protokollierung von Anfragen und Antworten zur Fehleranalyse und Nachverfolgung.

Grundkonzepte

Um die App effektiv zu nutzen, ist das Verständnis der folgenden Kernkonzepte wichtig:

API-Verbindungen

Eine API-Verbindung repräsentiert die Verbindung zu einem externen System oder Dienst (z.B. einem Dokumentenmanagementsystem, einem Webshop oder einem Zahlungsdienstleister). Hier werden die grundlegenden Eigenschaften wie die Basis URL (Basis-Adresse des Dienstes) und die Authentifizierungsmethode hinterlegt.

Verbindungsendpunkte

Ein Endpunkt ist eine spezifische Ressource oder Funktion, die über die API-Verbindung angesprochen wird.

  • Beispiel: Wenn die API-Verbindung zu https://api.example.com führt, könnte ein Endpunkt /customers sein, um Kundendaten abzurufen.
  • Jeder Endpunkt hat eine definierte HTTP-Methode (z.B. GET zum Lesen, POST zum Erstellen).

Parameter

Parameter ermöglichen die dynamische Steuerung der Anfragen. Sie können an verschiedenen Stellen der HTTP-Anfrage eingesetzt werden:

  • Kopfzeile: Metadaten wie Content-Type oder API-Keys.
  • Query: Filter oder Optionen in der URL (z.B. ?filter=active).
  • URL: Platzhalter im Pfad (z.B. /customers/{{id}}).
  • Text: Nutzdaten, die an den Server gesendet werden (oft im JSON-Format).

Authentifizierung

Die App kümmert sich um die sichere Anmeldung am externen System. Unterstützt werden unter anderem:

  • Basic Authentication: Benutzername und Passwort.
  • OAuth2: Token-basierte Authentifizierung (oft verwendet für moderne Cloud-Dienste), inklusive automatischer Token-Erneuerung.
  • API Key: Authentifizierung über einen geheimen Schlüssel im Header oder der URL.

Protokollierung

Jede Kommunikation kann protokolliert werden. Das API-Verbindungsprotokoll speichert Request- und Response-Daten, Statuscodes und Fehlermeldungen, was für das Debugging und Monitoring essenziell ist.