Request für API-Endpunkt ausführen - Beispiel mit Postman

Voraussetzungen

• API-Endpunkt wurde erstellt

• API-Key für den Endpunkt wurde erstellt

Schritt-für-Schritt

Um einen Request für einen API-Endpunkt (POST) mit Postmann auszuführen, gehen Sie wie folgt vor:

1. Starten Sie die Applikation.

2. Klicken Sie auf den Bereich "API-Endpunkte".

   Achten Sie darauf, dass die Ansicht der API-Endpunkte aktiviert ist.

   ("Ansicht" > API-Endpunkte")

3. Markieren Sie den Endpunkt, für den Sie den Request ausführen möchten.

4. Drücken Sie die rechte Maustaste.

5. Ein Kontextmenü wird angezeigt.

6. Wählen Sie den Eintrag "Endpunkt-URL in Zwischenablage kopieren".

   

   Im rechten unteren Bereich des Fensters wird eine Meldung über das erfolgte Speichern der API-URL angezeigt.

   

7. Fügen Sie die API-URL in Notepad ein.

8. Wechseln Sie in das Menü "Integration".

9. Klicken Sie auf "Application-API" > "API-Keys".

10. Markieren Sie den gewünschten API-Key.

11. Drücken Sie die rechte Maustaste.

    Ein Kontextmenü wird angezeigt.

12. Wählen Sie den Eintrag "API-Key kopieren" aus.

13. Fügen Sie die API-Key in Notepad ein.

14. Starten Sie Postman.

15. Wählen Sie als Methode "POST" aus.

16. Fügen Sie die API-URL in das Feld neben der Methode ein ().

17. Wechseln Sie in den Tab "Headers".

18. Tragen Sie in der Spalte "KEY" den Text "X-API-KEY" ein.

19. Fügen Sie in die Spalte "Value" den API-Key ein ().

    

20. Wechseln Sie in das Tab "Body" (), Option "raw" (), Auswahl JSON ().

21. Erfassen Sie den Request JSON Body () aus dem API-Endpunkt.

    

22. Klicken Sie auf Send.

    Der Request wird ausgeführt und die Rückgabewerte der Anfrage werden angezeigt.