Installation und Updates > AddOne.API > Nutzung

Die AddOne.API stellt für jedes Modul eine interaktive GraphQL-Dokumentation bereit.

Diese Dokumentation ermöglicht es Ihnen, verfügbare Abfragen, Datenfelder und Änderungsfunktionen zu erkunden und direkt auszuprobieren.

Dokumentation öffnen

Zum Öffnen der Dokumentation benötigen Sie:

•die Basis-URL der API

•die Nummer des gewünschten Mandanten

Beispiel:

https://server:5000/api/mandanten/1/graphql

Nach dem Öffnen erscheint die Startseite der integrierten GraphQL-Dokumentation.

Wählen Sie anschließend das gewünschte Modul aus, indem Sie dessen Namen in die URL aufnehmen.

Beispiel:

https://server:5000/api/mandanten/1/stammdaten/graphql

Über Browse Schema bzw. Schema durchsuchen erhalten Sie eine Übersicht aller verfügbaren Objekte.

Hier können Sie:

•verfügbare Queries anzeigen

•verfügbare Mutations anzeigen

•Datentypen erkunden

•verfügbare Felder einsehen

Queries dienen zum Lesen von Daten.

Je nach Modul stehen unterschiedliche Abfragen zur Verfügung.

Beispielsweise:

•Adressen

•Ansprechpartner

•Artikel

•Zahlungsziele

Nach Auswahl einer Query zeigt die Dokumentation alle verfügbaren Felder an.

Mutations dienen zum Erstellen oder Ändern von Daten.

Ob Mutations verwendet werden können, hängt von den vergebenen Berechtigungen des API-Keys ab.

Die Dokumentation unterstützt Sie beim Erstellen eigener GraphQL-Abfragen.

Während der Eingabe werden verfügbare Objekte und Felder automatisch vorgeschlagen.

Dadurch lassen sich Abfragen ohne Kenntnis aller Feldnamen komfortabel erstellen.

Zum Wechseln in ein anderes Modul muss lediglich der Modulname innerhalb der URL angepasst werden.

Alle verfügbaren Objekte werden anschließend automatisch aktualisiert.