Die AddOne.API mit Postman testen

<< Klicke, um Inhaltsverzeichnis anzuzeigen >>

Navigation:  Installation und Updates > AddOne.API > Nutzung >

Die AddOne.API mit Postman testen

Postman eignet sich hervorragend, um API-Abfragen zu testen und erste GraphQL-Abfragen zu entwickeln.

 

Neue Anfrage erstellen

Erstellen Sie eine neue POST-Anfrage.

Als URL verwenden Sie den gewünschten GraphQL-Endpunkt.

Beispiel:

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

 

API-Key hinterlegen

Öffnen Sie den Reiter Authorization oder tragen Sie den Header manuell ein.

X-AddOne-Api-Key: <Ihr API-Key>

 

GraphQL-Abfrage eingeben

Wählen Sie im Bereich Body den Typ GraphQL aus.

Tragen Sie anschließend Ihre Abfrage ein.

Beispiel:

query {
   steuerschluessel {
       id
       bezeichnung
   }
}

 

Anfrage ausführen

Senden Sie die Anfrage.

Die Antwort wird im unteren Bereich von Postman als JSON-Dokument angezeigt.

 

Häufige Fehler

 

Keine Verbindung möglich

Prüfen Sie:

Servername

Port

Firewall

Erreichbarkeit der API

 

Unauthorized

Der API-Key ist ungültig oder wurde nicht korrekt übertragen.

 

Keine Daten

Prüfen Sie:

den verwendeten Mandanten

den Modulnamen

die verwendete Query

die Berechtigungen des API-Keys

 

Nächste Schritte

Sobald die Verbindung erfolgreich funktioniert, können Sie komplexere GraphQL-Abfragen erstellen und die vollständige API-Referenz der einzelnen Module nutzen.