Metagrapho-documentatie
Inleiding
De Transkribus-API vergemakkelijkt de verwerking van afbeeldingen met behulp van de Transkribus HTR-technologie (Handwritten Text Recognition). Met deze API kunnen gebruikers afbeeldingen indienen voor verwerking en later resultaten ophalen met behulp van de verstrekte processId.
Authenticatie
Om met de Transkribus-API te communiceren, moet u eerst verifiëren om een toegangstoken te verkrijgen. De API maakt gebruik van het OpenID Connect-protocol voor authenticatie. Hier volgt een stapsgewijze handleiding voor het verkrijgen en beheren van uw toegangstokens.
Voor bepaalde bibliotheken hebt u mogelijk de OpenID Connect-configuratie-URL nodig, die beschikbaar is op: https://account.readcoop.eu/auth/realms/readcoop/.well-known/openid-configuration
1. Verkrijg een toegangstoken
Gebruik de volgende cURL-opdracht, waarbij u staud en vervangt door uw inloggegevens:
curl --location --request POST https://account.readcoop.eu/auth/realms/readcoop/protocol/openid-connect/token
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode grant_type=password
--data-urlencode username=staud
--data-urlencode password=
--data-urlencode client_id=processing-api-client
Bij succesvolle authenticatie ontvangt u een toegangstoken in het antwoord. Bovendien ontvangt u een vernieuwingstoken die kan worden gebruikt om een nieuw toegangstoken te verkrijgen zodra het huidige verloopt.
2. Het toegangstoken vernieuwen
Als uw toegangstoken verloopt, kunt u het verstrekte vernieuwingstoken gebruiken om er een nieuw mee te verkrijgen met deze opdracht:
curl --location --request POST https://account.readcoop.eu/auth/realms/readcoop/protocol/openid-connect/token
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode grant_type=refresh_token
--data-urlencode client_id=processing-api-client
--data-urlencode refresh_token=
Vervang door uw vernieuwingstoken. Werk uw vernieuwingstoken bij als het antwoord een nieuw bevat.
3. De sessie beëindigen
Gebruik het volgende om u af te melden en het vernieuwingstoken ongeldig te maken:
curl --location --request POST https://account.readcoop.eu/auth/realms/readcoop/protocol/openid-connect/logout
--header 'Content-Type: application/x-www-form-urlencoded'
--data-urlencode refresh_token=
--data-urlencode client_id=processing-api-client
Factureringsgegevens
Standaard gebruikt de Transkribus-API het interne krediet-systeem van Transkribus voor facturering. Bij verzoek kan echter een systeem voor betalen per gebruik worden geregeld.