Wie Sie mit der Flexi-API beginnen (2/6)

Welches Programm Sie zum Testen der REST-API verwenden sollten

Petr Pech avatar
Verfasst von Petr Pech
Vor über einer Woche aktualisiert

Wir

empfehlen und führen alle Tests in Postman

für die

Flexi-Unterstützung durch. Schauen wir uns also an, wie man damit arbeitet. Es kann kostenlos bei GetPostman heruntergeladen oder als Erweiterung zu Google Chrome hinzugefügt werden (wir empfehlen stattdessen eine Desktop-Anwendung). Die Verbindung von Flexi mit anderer Software wird mit einem eigenen Skript erfolgen, aber für unsere Tests ist der bereits erwähnte Postman

ausreichend.

Für jede Operation ist zunächst eine Benutzerauthentifizierung erforderlich, die Sie auf der Registerkarte Auth vornehmen. Zum Testen ist der Typ Basic Auth ausreichend.
Wenn Sie einen bestimmten Benutzer nur für den Zugriff über die REST-API verwenden möchten, empfehlen wir die "Benutzer-API", eine kostengünstigere Variante ohne Schreibtischzugang. Anwendung - siehe Preisliste

.

Wir unterstützen andere Authentifizierungsmethoden, siehe unsere Dokumentation.

1) Auswahl der HTTP-Operation (GET, POST, PUT, DELETE, ...)

  • Das Programm Postman bietet eine Vielzahl von unterstützten Operationen, jedoch sind die 4 oben genannten derzeit für die Arbeit mit Flexi ausreichend.

  • Die Bedeutung dieser Operationen werden wir im Artikel HTTP-Operationen erläutern.

2) Feld zur Eingabe der URL-Adresse, mit der Postman arbeiten soll

3) Auswählen des Formats, in dem die Daten an die URL gesendet werden

  • ACHTUNG - die URL-Erweiterung muss mit dem Format der zu sendenden Daten übereinstimmen.

4) Auswählen des Formats der zu erstellenden Anfrage (standardmäßig roh)

5) Hier wird nach dem Senden der Anfrage an die angegebene URL die Antwort angezeigt

  • im Falle einer GET-Operation - Flexi-Antwort im gewünschten Format (XML/JSON)

  • bei POST-, PUT-, DELETE-Operation - Flexi-Antwort mit dem Ergebnis der Operation, z. B:

¨

6) Anfragekörper (Request)

  • Körper im XML/JSON-Format

  • Beispiel:

  • Erzeugt eine ausgestellte Rechnung mit Code "TESTFAKE", Dokumentart INVOICE (Standardrechnung), ausgestellt am 1. Januar 2018 mit Var. Symbol "20180101"

Hat dies Ihre Frage beantwortet?