Beispiele für API-Aufrufe

API-Aufrufe zum Hochladen von Dokumenten und zur Statusprüfung

Die API-Integration bietet Funktionen und Dienste, die Anwendungen und Prozesse miteinander verbinden. In diesem Leitfaden zeigen wir Ihnen, wie Sie API-Aufrufe über api.polydocs.io zum Hochladen von Dokumenten und zur Statusprüfung durchführen.

Authentifizierung

Um API-Aufrufe durchzuführen, ist die Authentifizierung der erste Schritt. Führen Sie zur Authentifizierung die folgenden Schritte aus:

Öffnen Sie api.polydocs.io.
Klicken Sie oben rechts auf Authorize.
Geben Sie Ihren API-Schlüssel in das Feld Value ein und bestätigen Sie indem Sie auf Authorize klicken und dann mit Close das Fenster schliessen.

Dokument hochladen

Um ein Dokument hochzuladen, folgen Sie den nachstehenden Schritten:

Nach der Authentifizierung scrollen Sie nach unten zum Aufruf POST /document/process.
Öffnen Sie die Registerkarte und klicken Sie in der oberen rechten Ecke auf Try it out .
Geben Sie den folgenden Wert in das Feld source ein: E-Mail:{Mustername}.
Wählen Sie die Datei aus, die Sie hochladen möchten, und klicken Sie auf Execute.

Ihr Dokument wird mit den von Ihnen in DocBits festgelegten Regeln auf Ihr Dashboard hochgeladen.

Prüfung des Dokumentstatus

Um den Status eines Dokuments zu überprüfen, gehen Sie wie folgt vor:

Nach der Authentifizierung scrollen Sie nach unten zum Aufruf GET /document/status endpoint.
Öffnen Sie die Registerkarte und klicken Sie in der oberen rechten Ecke auf Try it out .
Geben Sie die Dokument-ID in das Feld doc-id ein, und klicken Sie auf Execute. Sie finden die Dokument-ID, wenn Sie das Dokument auf dem Dashboard öffnen. Dies ist der letzte Teil der URL, wenn das Dokument geöffnet ist.

Sie erhalten folgende Antwort:

Wenn der Status “Ready For Validation,” angezeigt wird, bedeutet dies, dass das Dokument für den Benutzer zur Validierung bereitsteht.

Dokument mit Metadaten hochladen

Um ein Dokument mit Metadaten hochzuladen, gehen Sie wie folgt vor:

Nach der Authentifizierung scrollen Sie nach unten zum Aufruf: POST /document/process_documents or /document/process or /document/process_base64.
Öffnen Sie die Registerkarte und klicken Sie in der oberen rechten Ecke auf Try it out .
Geben Sie die Metadaten in das Feld metadata ein. Die Metadaten müssen in einem gültigen JSON-Format vorliegen. Ein Beispiel für einen Metadateneintrag wäre: {"custom-key": "the custom value", "custom_doc_id": "8a5cf33b-c923-4879-96ca-94d69965d508"}.
Wählen Sie eine Datei zum Hochladen aus.
Klicken Sie auf Execute.
Warten Sie auf die Antwort. Wenn das Metadatenfeld kein gültiges JSON ist, wird eine Fehlermeldung angezeigt. Wenn “success”: true, wird Ihr Dokument mit den Regeln, die Sie in DocBits festgelegt haben, in Ihr Dashboard hochgeladen.

Wenn Sie diese einfachen Schritte befolgen, können Sie problemlos API-Aufrufe zum Hochladen von Dokumenten und für Statusprüfungen durchführen.