Wie benutzt man Postman?

Pläne, die den Zugriff auf API-Token-Einstellungen im Wissensdatenbank-Portal unterstützen

Postman ist eine API-Plattform zum Erstellen und Verwenden von APIs. Die Verknüpfung Ihres Document360-Projekts mit Postman ist einfach und in wenigen Minuten abgeschlossen. Sie können den lokalen oder den webbasierten Postman verwenden.

ANMERKUNG

Weitere Informationen zur Postman-Anwendung finden Sie in den folgenden Artikeln.

• How to download Postman application?

• Wie installiere und aktualisiere ich die Postman-Anwendung?

• Wie benutzt man Postman?

• FAQs in Postman

Verknüpfen Ihres Document360-Projekts in Postman

Die folgenden Schritte basieren auf der lokalen Postman-Anwendung.

1. Öffnen Sie die Postman-Anwendung.

2. Klicken Sie im Abschnitt Mein Arbeitsbereich auf die Schaltfläche Importieren.

   Ein Popup-Fenster "Importieren" wird angezeigt.

3. Geben Sie die folgende URL in das Feld ein.
   https://apihub.document360.io/swagger/v2/swagger.json
   

   Das Pop-up Wählen Sie, wie Sie Ihre API importieren möchten , wird mit zwei Optionen angezeigt.

4. Wählen Sie die gewünschte Option aus

   • Postman Collection (Standard)

   • OpenAPI 3.0 mit einer Postman Collection

5. Klicken Sie auf die Schaltfläche Importieren .

   Sobald der Import abgeschlossen ist, erstellt die Aktion eine Beispielanforderung für jeden Endpunkt, sodass Sie die Anforderung schnell stellen können.
   

   

Authentifizierung in Postman - Generieren eines API-Tokens

1. Erweitern Sie in der Strukturansicht die Option Document360 Customer API.

2. Legen Sie auf der Registerkarte Autorisierung den Authentifizierungstyp in der Dropdown-Liste auf API-Schlüssel fest.

3. Geben Sie die gewünschte Variable in das Feld Schlüssel ein.

4. Geben Sie das API-Token in das Feld Wert ein. Informationen zum Generieren eines API-Tokens finden Sie im Artikel auf Generating token.

   ANMERKUNG

   Generieren eines API-Tokens

   ein. Navigieren Sie zu Einstellungen > Knowledge Base-Portal > API-Token.

   b. Erstellen Sie das gewünschte API-Token, und kopieren Sie das Token.

   (oder) Kopieren Sie das Token aus einem vorhandenen Token.

1. Wechseln Sie in der linken Navigationsleiste zu Umgebungen.

2. Klicken Sie im linken Navigationsbereich auf Umgebungen erstellen.

3. Geben Sie in der Spalte "Variablen" einen Variablennamen ein, z. B. "base_URL", und legen Sie den Typ auf den Standardwert fest.

4. Eintreten https://apihub.document360.io in den Feldern INITIAL VALUE und CURRENT VALUE für die Basis-URL.

5. Klicken Sie auf die Schaltfläche Speichern .

   Die Projektauthentifizierung ist abgeschlossen. Jetzt können Sie ganz einfach auf alle verfügbaren Endpunkte zugreifen und verschiedene Aktionen ausführen.

   

Anwendungsfälle

Mit Hilfe von Postman können Sie verschiedene Aktionen in Document360 ausführen.

Hier sind ein paar grundlegende Anwendungsfälle als Referenz

• Wie erstelle und veröffentliche ich einen Artikel?

• Wie aktualisiere ich einen veröffentlichten Artikel?

• Wie aktualisiere ich SEO-Details?

Häufig gestellte Fragen