Mit der externen API können Sie die originalen und anonymisierten Dokumente Ihrer Projekte sowie die zugehörigen aktuellen Projektkonfigurationen herunterladen. Die Zuordnung erfolgt über die jeweilige Projekt-ID.
Eine vollständige Beschreibung aller Endpunkte und Antwortfelder finden Sie in der API-Dokumentation.
Voraussetzung
Senden Sie Ihren API-Key bei jeder Anfrage im Authorization-Header:
Authorization: Bearer <API-Key>
1. Verfügbare Projekte abrufen
Die Antwort enthält alle Projekte, auf die Ihr API-Key zugreifen darf. Führen Sie die folgenden Schritte für jedes zurückgegebene Projekt aus.
2. Projektkonfiguration herunterladen
Ersetzen Sie {projectId} durch die ID aus Schritt 1 und speichern Sie die Antwort beispielsweise als config.json.
3. Dokumente eines Projekts abrufen
Die Ergebnisse werden seitenweise ausgegeben. Rufen Sie alle Seiten ab und berücksichtigen Sie Dokumente mit dem Status COMPLETED oder FINALIZED.
4. Anonymisierte Dokumente herunterladen
Anonymisiertes Dokument herunterladen
Ersetzen Sie {projectId} und {documentId} durch die Werte aus der Dokumentliste. Wiederholen Sie diesen Schritt für jedes Dokument.
Falls die API mit Status 409 antwortet, wird das Dokument noch erstellt. Versuchen Sie den Download nach kurzer Zeit erneut.
5. Originaldokumente herunterladen
Originaldokument herunterladen
Verwenden Sie dieselbe Projekt- und Dokument-ID wie beim Download des anonymisierten Dokuments. Wiederholen Sie diesen Schritt für jedes Dokument.
Originaldokumente sind nur verfügbar, wenn sie im jeweiligen Projekt gespeichert werden. Andernfalls antwortet die API mit Status 403.