So nutzen Sie die API

Schritt 1: API-Schlüssel abrufen

Der API-Zugang ist in allen kostenpflichtigen Tarifen enthalten. So erhalten Sie Ihren API-Schlüssel:

1. Melden Sie sich in Ihrem Konto an
2. Gehen Sie zu Einstellungen
3. Scrollen Sie nach unten zum Abschnitt API-Zugang
4. Kopieren Sie Ihren API-Schlüssel

Ihr API-Schlüssel beginnt mit uk_, gefolgt von einer langen Zeichenkette. Bewahren Sie diesen Schlüssel sicher auf – jeder, der Ihren Schlüssel besitzt, kann API-Anfragen im Namen Ihres Kontos stellen.

Schritt 2: Kontoauszug hochladen

Um eine Kontoauszugs-PDF hochzuladen, senden Sie eine POST-Anfrage an /api/v1/extract mit Ihrer Datei als Formulardaten.

Fügen Sie Ihren API-Schlüssel im Authorization-Header ein:

Authorization: Bearer uk_your_api_key_here

Beispiel mit curl:

curl -X POST https://ukstatementconverter.co.uk/api/v1/extract \
  -H "Authorization: Bearer uk_your_api_key_here" \
  -F "file=@statement.pdf"

Die Antwort enthält eine file_id, die Sie verwenden, um den Status zu prüfen und Ergebnisse herunterzuladen:

{
  "success": true,
  "file_id": "doc_abc123...",
  "status": "processing",
  "page_count": 5
}

Schritt 3: Verarbeitungsstatus prüfen

Die Verarbeitung dauert in der Regel nur wenige Sekunden, bei größeren Kontoauszügen kann es jedoch länger dauern. Fragen Sie den Status-Endpunkt ab, bis die Verarbeitung abgeschlossen ist:

curl https://ukstatementconverter.co.uk/api/v1/status?file_id=doc_abc123 \
  -H "Authorization: Bearer uk_your_api_key_here"

Der Status ist einer der folgenden:

• processing – Wird noch verarbeitet
• completed – Bereit zum Herunterladen
• failed – Verarbeitung fehlgeschlagen (prüfen Sie die Fehlermeldung)

Schritt 4: Ergebnisse herunterladen

Sobald der Status completed lautet, laden Sie Ihre Ergebnisse im bevorzugten Format herunter:

curl https://ukstatementconverter.co.uk/api/v1/download?file_id=doc_abc123&format=json \
  -H "Authorization: Bearer uk_your_api_key_here"

Verfügbare Formate:

• json – Strukturierte Daten, ideal für den programmatischen Zugriff
• csv – Einfaches tabellarisches Format
• xlsx – Excel-Tabelle

Verwendung von Postman

Wir stellen eine sofort einsatzbereite Postman-Sammlung mit allen vorkonfigurierten Endpunkten bereit. Laden Sie sie von der API-Dokumentationsseite herunter.

Nach dem Import der Sammlung:

1. Setzen Sie die Variable api_key auf Ihren API-Schlüssel
2. Führen Sie "Upload Statement" aus – wählen Sie eine PDF-Datei aus
3. Die file_id wird automatisch für nachfolgende Anfragen gespeichert
4. Führen Sie "Check Status" aus, bis der Status "completed" lautet
5. Führen Sie "Download as JSON" aus, um Ihre Transaktionsdaten zu erhalten

Kontingent prüfen

API-Anfragen werden auf das Seitenkontingent Ihres Tarifs angerechnet. So prüfen Sie Ihr verbleibendes Kontingent:

curl https://ukstatementconverter.co.uk/api/v1/user \
  -H "Authorization: Bearer uk_your_api_key_here"

Dies gibt Ihre Kontoinformationen zurück, einschließlich der in diesem Abrechnungszeitraum genutzten und verbleibenden Seiten.