Einführung

Die Transkribus-API erleichtert die Verarbeitung von Bildern mit der Transkribus HTR-Technologie (Handwriting Text Recognition). Mit dieser API können Benutzer Bilder zur Verarbeitung einreichen und später mit der bereitgestellten ProcessId Ergebnisse abrufen.

Authentifizierung

Um mit der Transkribus-API zu interagieren, müssen Sie sich zunächst authentifizieren, um ein Zugriffstoken zu erhalten. Die API verwendet das OpenID Connect-Protokoll zur Authentifizierung. Hier ist eine schrittweise Anleitung zum Abrufen und Verwalten Ihrer Zugriffstokens.

Für einige Bibliotheken benötigen Sie möglicherweise die OpenID Connect-Konfigurationsurl, die unter folgender Adresse verfügbar ist: https://account.readcoop.eu/auth/realms/readcoop/.well-known/openid-configuration

1. Zugriffstoken abrufen

Verwenden Sie den folgenden cURL-Befehl und ersetzen Sie $USERNAME und $PASSWORD durch Ihre Anmeldedaten:

curl --location --request POST https://account.readcoop.eu/auth/realms/readcoop/protocol/openid-connect/token \n--header 'Content-Type: application/x-www-form-urlencoded' \n--data-urlencode grant_type=password \n--data-urlencode username=$USERNAME \n--data-urlencode password=$PASSWORD \n--data-urlencode client_id=processing-api-client
    

Nach erfolgreicher Authentifizierung erhalten Sie ein Zugriffstoken in der Antwort. Zusätzlich erhalten Sie ein Aktualisierungstoken, mit dem Sie ein neues Zugriffstoken abrufen können, sobald das aktuelle abläuft.

2. Zugriffstoken aktualisieren

Wenn Ihr Zugriffstoken abläuft, können Sie das bereitgestellte Aktualisierungstoken mit diesem Befehl verwenden, um ein neues zu erhalten:

curl --location --request POST https://account.readcoop.eu/auth/realms/readcoop/protocol/openid-connect/token \n--header 'Content-Type: application/x-www-form-urlencoded' \n--data-urlencode grant_type=refresh_token \n--data-urlencode client_id=processing-api-client \n--data-urlencode refresh_token=$REFRESH_TOKEN
    

Ersetzen Sie $REFRESH_TOKEN durch Ihr Aktualisierungstoken. Aktualisieren Sie Ihr Aktualisierungstoken, wenn die Antwort ein neues enthält.

3. Sitzung beenden

Um sich abzumelden und das Aktualisierungstoken zu invalidieren, verwenden Sie:

curl --location --request POST https://account.readcoop.eu/auth/realms/readcoop/protocol/openid-connect/logout \n--header 'Content-Type: application/x-www-form-urlencoded' \n--data-urlencode refresh_token=$REFRESH_TOKEN \n--data-urlencode client_id=processing-api-client
    

Abrechnungsinformation

Standardmäßig verwendet die Transkribus-API das interne Kreditsystem von Transkribus zur Abrechnung. Auf Anfrage kann jedoch ein Pay-Per-Use-Abrechnungssystem arrangiert werden.