Wie man den Postboten benutzt

Postman ist eine API zum Erstellen und Nutzen von APIs. Die Verknüpfung Ihres Document360-Projekts mit Postman ist einfach und kann in wenigen Minuten abgeschlossen werden. Sie können den Postboten vor Ort oder online nutzen.

HINWEIS

Für weitere Informationen zur Postman-Anwendung lesen Sie bitte die folgenden Artikel.

• Wie lädt man die Postman-Anwendung herunter?

• Wie installiert und aktualisiert man die Postman-Anwendung?

• Wie benutzt man Postman?

• FAQs in Postman

Verlinkung Ihres Document360-Projekts in Postman

1. Die folgenden Schritte basieren auf der On-Premises-Bewerbung für den Postboten.

2. Öffnen Sie die Postboten-Bewerbung.

3. Im Bereich Mein Arbeitsbereich klicken Sie auf die Schaltfläche Importieren .

   Ein Import-Popup-Panel erscheint.

4. Geben Sie die untenstehende URL im Feld ein.
   https://apihub.document360.io/swagger/v2/swagger.json
   Das Pop-up "Wie du deine API importierst " erscheint mit zwei Optionen.

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

   • Postbotensammlung (Standard)

   • OpenAPI 3.0 mit einer Postman-Sammlung

6. Klicken Sie auf die Schaltfläche Importieren .

   Sobald der Import abgeschlossen ist, erstellt die Aktion für jeden Endpunkt eine Beispielanfrage, sodass Sie die Anfrage schnell ausführen können.
   

   

Authentifizierung in Postman – Generierung eines API-Tokens

1. Erweitern Sie in der Baumansicht die Document360 Customer API.

2. Im Tab Autorisierung setzen Sie den Auth-Typ aus dem Dropdown-Menü auf API-Schlüssel.

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

4. Geben Sie das API-Token im Wertfeld ein. Um ein API-Token zu generieren, lesen Sie den Artikel über Token-Generierung.

   HINWEIS

   Generierung eines API-Tokens

   1. Navigiere zu () in der linken Navigationsleiste im Knowledge Base-Portal.

   2. Im linken Navigationsfenster navigieren Sie zum Knowledge base portal > API-Tokens.

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

   (oder) Kopiere den Token von einem bestehenden Token.

1. Gehe in der linken Navigationsleiste zu Umgebungen.

2. Klicken Sie im linken Navigationsfenster auf Umgebungen erstellen.

3. Unter der Spalte Variablen geben Sie zum Beispiel einen Variablennamen ein, zum Beispiel 'base_URL', und setzen Sie den Typ auf Standard.

4. Geben Sie die Felder INITIAL VALUE und CURRENT VALUE für die Basis-URL einhttps://apihub.document360.io.

5. Klicken Sie auf die Schaltfläche Speichern .

   Die Projektauthentifizierung ist abgeschlossen. Jetzt kannst du 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 einige grundlegende Anwendungsfälle zur Referenz

• Wie erstellt und veröffentlicht man einen Artikel?

• Wie aktualisiert man einen veröffentlichten Artikel?

• Wie aktualisiert man SEO-Details?

FAQ