API

Zuletzt bearbeitet: 17. Juli 2024

Der Madaster API-Endpunkt kann verwendet werden, um mit der Madaster-Plattform und ihren Funktionen zu interagieren. Diese API deckt noch nicht alle Funktionen der Plattform vollständig ab, bitte beachten Sie die OpenAPI-Dokumentation.

News zu Entwicklungen

Melden Sie sich für den Newsletter (auf Englisch) an, um Updates bezüglich der API zu erhalten.

Abonnieren Sie die Madaster API Updates

* erforderliche Angaben

Token

Um auf die API-Ressourcen zugreifen zu können, benötigen Sie einen Autorisierungs-Token. Wenn Sie noch keinen haben, lesen Sie das folgende Kapitel über die Autorisierung. Dieser Token sollte als Header mit dem Namen ‘X-API-Key’ gesendet werden, wodurch die Anfrage mit dem Token authentifiziert wird.

Autorisierung

Um auf die Dienste der API zugreifen zu können, benötigen Sie einen API-Schlüssel. Dieser Schlüssel muss im X-API-Key-Header an die Anfrage angehängt werden. Um einen API-Schlüssel zu erhalten, müssen Sie einen Token in der Madaster-Plattform hinzufügen oder den Administrator Ihres Accounts bitten, dies für Sie zu tun. Dadurch erhalten Sie Zugriff auf die Ressourcen und die damit verbundenen Entitäten.

Hinzufügen eines Tokens zu einem Account, Ordner, Objekt oder einer Datenbank

  1. Klicken Sie auf der gewünschten Ebene auf den Tab Benutzer, zugänglich über das Symbol am Ende der Tableiste.
  2. Klicken Sie auf API-Token hinzufügen .
  3. Geben Sie einen Namen für den Token ein und kopieren Sie den generierten Token. Wählen Sie die Berechtigungsstufe sowie die Ablaufzeit und klicken Sie abschließend auf Speichern

Versionen

Die API wird ständig verbessert, so dass im Laufe der Zeit weitere Versionen der Schnittstelle hinzugefügt werden. Welche Versionen welche API-Aufrufe unterstützen, finden Sie in der OpenAPI-Dokumentation. Es wird empfohlen, immer die neueste verfügbare Version für eine API-Anfrage zu verwenden. Die alten Versionen bleiben jedoch noch eine Zeit lang aus Legacy-Zwecken verfügbar. Um eine API-Version auszuwählen, hängen Sie das Versions-Tag an den API-Endpunkt an. Für Version 4.0 verwenden Sie zum Beispiel https://api.madaster.com/api/v4.0

Beispiele

Im Github-Repository finden Sie einige Beispiele, wie Sie mit der API in verschiedenen Programmiersprachen interagieren können.