Wie kann ich die REST-API in Postman nutzen?
Antwort:
Die REST-API von DocuWare ist zugänglicher denn je. Bitte lesen Sie die folgende Anleitung, um Postman für die REST-API einzurichten.
Erste Schritte
Postman Download
Empfohlene Plattform zum Testen und Erstellen von Anwendungen mit REST API.
DocuWare's REST API Postman Collection
Vorkonfigurierte Sammlung von DocuWare-relevanten API-Aufrufen, die in Postman importiert werden kann und ständig aktualisiert wird.
Importieren der Postman-Sammlung
- Entpacken Sie den heruntergeladenen Postman Collection-Ordner. Darin sollten sich zwei .json-Dateien befinden.
- Die eine Datei enthält die eigentliche Sammlung der API-Aufrufe, die andere die Umgebung, die einige erforderliche Variablen enthält, z. B. Ihre DocuWare Cloud-URL, Ihren Benutzernamen und Ihr Passwort.
- Öffnen Sie Postman und verwenden Sie die Option Importieren am oberen Rand des Arbeitsbereichs-Editors.
- Ziehen Sie die beiden Dateien per Drag & Drop oder navigieren Sie manuell zum Downloadort, um beide Dateien zu importieren.
- Akzeptieren Sie die Aufforderung, beide Dateien zu importieren.
Definieren von Umgebungsvariablen
- Öffnen Sie die Registerkarte Umgebungen auf der linken Seite und wählen Sie unsere neu importierte DocuWare-Umgebung
- Hier werden Sie eine Menge verschiedener Variablen sehen, aber die meisten sind anwendungsspezifisch und können vorerst in Ruhe gelassen werden. Einige wichtige Variablen für den Anfang sind:
- ServerUrl (endet auf .cloud / .com etc. - wir füllen die DocuWare/Plattform in eine andere Variable)
- Benutzername
- Kennwort
- Speichern Sie Ihre Änderungen.
Authentifiziert werden
Es gibt eine Handvoll Möglichkeiten, sich über die REST-API zu authentifizieren, aber die einfachste ist die Verwendung unseres Benutzernamens und Passworts. In der Postman Collection sind diese entsprechend nummeriert, um diesen Vorgang zu vereinfachen:- Öffnen Sie den Ordner Authentication/OAuth in der Postman Collection
- Beginnen Sie mit dem Aufruf 1. Get Responsible Identity Service und drücken Sie Senden. Vorausgesetzt, Ihre ServerUrl-Variable ist korrekt gesetzt, sollten Sie eine 200-Antwort erhalten:
- Als nächstes machen Sie dasselbe für 2. Identitätsdienst-Konfiguration abrufen
- Wählen Sie schließlich die gewünschte Authentifizierungsmethode aus. In diesem Beispiel verwenden wir 3.a Request Token w Username & Password, und wir sollten unser Access Token in der Antwort erhalten.
- Jetzt sind Sie ordnungsgemäß authentifiziert und können mit dem Testen der verschiedenen anderen Aufrufe innerhalb der Postman Collection beginnen!
Die meisten unserer REST-API-Dokumente finden Sie direkt in Postman selbst über die Registerkarte Dokumentation auf der rechten Seite:
KBA ist sowohl für Cloud- als auch für On-Premise-Organisationen anwendbar
Bitte beachten Sie: Dieser Artikel ist eine Übersetzung aus dem Englischen. Die in diesem Artikel enthaltenen Informationen basieren auf der/den englischsprachigen Originalversion(en) des Produkts. In der übersetzten Version unserer Artikel können kleinere Fehler enthalten sein, z.B. in der Grammatik. Wir können zwar nicht für die vollständige Richtigkeit der Übersetzung garantieren, aber in den meisten Fällen werden Sie sie als ausreichend informativ empfinden. Im Zweifelsfall wechseln Sie bitte zurück zur englischen Version dieses Artikels.