Administrationsleitfäden

Postman für DocBits

Dieser Leitfaden zeigt Ihnen, wie Sie über Postman HTTP-Anfragen an Ihre DocBits-Organisation stellen. Es ist einfach zu verwenden und für Organisationsadministratoren sehr nützlich.

Einrichtung

Laden Sie zunächst Postman auf Ihr System herunter und melden Sie sich an bzw. registrieren Sie sich.

Folgen Sie nun dieser Schritt-für-Schritt-Anleitung, um zu lernen, wie HTTP-Anfragen in Postman funktionieren.

Autorisierung

In Postman

Bevor Sie Ihre HTTP-Anfragen erstellen können, müssen Sie Ihren API-Schlüssel von DocBits eingeben, um sie zu autorisieren.

Klicken Sie auf die Registerkarte Authorization und wählen Sie API-Key als Autorisierungstyp.

Füllen Sie die Werte aus. Geben Sie x-api-key in das Feld Key und Ihren API-Schlüssel als Wert ein (zu finden im DocBits Menü Einstellungen unter Integration) Wählen Sie Add to Header.

Es sollte so aussehen:

Auf DocBits API

Verfügbar unter https://api.polydocs.io

Klicken Sie oben rechts auf Authorize

Geben Sie Ihren API-Schlüssel ein und bestätigen Sie mit einem Klick auf Authorize.

Erstellen Sie einen neuen Workspace in Postman

Klicken Sie auf Workspace und Create Workspace.

Sie können ihm einen beliebigen Namen geben
Sie müssen die Sichtbarkeit auswählen, die bestimmt, wer auf diesen Arbeitsbereich zugreifen kann.

Nachdem Sie Ihre Auswahl getroffen und auf Create Workspace geklickt haben, wählen Sie Collections auf der linken Seite der Anwendung und erstellen eine neue Sammlung für Ihre HTTP-Anfragen, indem Sie auf + klicken.

In dieser Sammlung können Sie mehrere HTTP-Anfragen hinzufügen. Klicken Sie dazu auf die 3 Punkte der Sammlung und wählen Sie Add request.

Beispiel für die Methode "GET"

Die GET-Methode ist sehr nützlich, um Informationen über Benutzer, Unterorganisationen, verarbeitete Dokumente und vieles mehr abzurufen.

Wählen Sie die GET-Methode in Ihrer HTTP-Anfrage.
Autorisieren Sie sich wie oben beschrieben.
Öffnen Sie https://api.polydocs.io und fügen Sie den Pfad der Funktion hinter der Polydocs URL ein. Zum Beispiel:
https://api.polydocs.io/docs#/users/get_users_users_get_users

Fügen Sie nun diesen Link in das Textfeld neben der GET-Methode in Postman ein.

Klicken Sie auf Send und Sie sollten alle Informationen über jeden Benutzer in Ihrer Organisation erhalten.

Beispiele für die Methode "POST"

Die POST-Methode wird in der Regel verwendet, um z.B. Benutzer oder Organisationen anzulegen. Diese Methode fügt Informationen in die Datenbank ein.

Benutzer anlegen

Wählen Sie die POST-Methode aus.
Autorisieren Sie sich wie oben beschrieben.
Öffnen Sie https://api.polydocs.io und fügen Sie den Pfad der Funktion hinter der Polydocs URL ein. In diesem Fall:
https://api.polydocs.io/docs#/users/create_user_users_create

Fügen Sie nun diesen Link in das Textfeld neben der POST-Methode in Postman ein.
Wählen Sie in Ihrer HTTP-Anfrage die Registerkarte „Body“ und geben Sie die Schlüssel und Werte für alle Anmeldeinformationen ein, neben deren Namen ein rotes Sternchen steht.

Wenn Sie fertig sind, sollte es so aussehen:

Wenn Sie ein Administratorkonto erstellen möchten, setzen Sie den Wert is_admin auf true.

Klicken Sie abschließend auf Send, und Sie können alle von Ihnen festgelegten Anmeldedaten in der Antwort unten sehen. Dies bedeutet, dass der Benutzer erstellt wurde.

Dokument hochladen

Sie können die POST-Methode auch verwenden, um ein Dokument in DocBits hochzuladen.

Wählen Sie die POST-Methode aus.
Autorisieren Sie sich wie oben beschrieben.
Öffnen Sie https://api.polydocs.io und fügen Sie den Pfad der Funktion hinter der Polydocs URL ein. In diesem Fall:
https://api.polydocs.io/docs#/document/process_document_process

Fügen Sie nun diesen Link in das Textfeld neben der POST-Methode in Postman ein.
Wählen Sie die Registerkarte Body in Ihrer HTTP-Anfrage und wählen Sie form-data.

Geben Sie file in das Feld KEY ein, wo Sie rechts im Feld das versteckte Dropdown-Menü File finden. Wählen Sie File und gehen Sie zum Feld VALUE, wo Sie Ihre Datei auswählen können, indem Sie auf Select Files klicken.
Wenn Sie auf Send klicken, sollten Sie in der Antwort „success“: true sehen.

Es sollte so aussehen:

Beispiel für die Methode "DELETE"

Mit der DELETE-Methode werden beispielsweise Benutzer, Organisationen usw. gelöscht.

Wählen Sie die DELETE-Methode aus.
Autorisieren Sie sich wie oben beschrieben.
Öffnen Sie https://api.polydocs.io und fügen Sie den Pfad der Funktion hinter der Polydocs URL ein. Zum Beispiel:
https://api.polydocs.io/docs#/users/delete_user_users_delete__user_id

Fügen Sie nun diesen Link in das Textfeld neben der DELETE-Methode in Postman ein.
Ersetzen Sie die {user_id} am Ende der URL durch die tatsächliche Benutzer-ID, die Sie löschen möchten. (Sie können die Benutzer-ID mit der GET-Methode abrufen).
Wenn Sie die Benutzer-ID in die URL eingefügt haben, müssen Sie keinen KEY und VALUE für den Body hinzufügen.
Wenn Sie auf Send klicken, sollte in der Antwort „success“: true angezeigt werden.