Documentation de Metagrapho
Introduction
L'API Transkribus facilite le traitement des images à l'aide de la technologie Transkribus HTR (Handwritten Text Recognition). Avec cette API, les utilisateurs peuvent soumettre des images pour traitement et récupérer ultérieurement les résultats à l'aide du processId fourni.
Authentification
Pour interagir avec l'API Transkribus, vous devez d'abord vous authentifier pour obtenir un jeton d'accès. L'API utilise le protocole OpenID Connect pour l'authentification. Voici un guide étape par étape pour obtenir et gérer vos jetons d'accès.
Pour certaines bibliothèques, vous pourriez avoir besoin de l'URL de configuration OpenID Connect, qui est disponible à : https://account.readcoop.eu/auth/realms/readcoop/.well-known/openid-configuration
1. Obtenir un jeton d'accès
Utilisez la commande cURL suivante, en remplaçant $USERNAME et $PASSWORD par vos identifiants :
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=$USERNAME \
--data-urlencode password=$PASSWORD \
--data-urlencode client_id=processing-api-client
En cas d'authentification réussie, vous recevrez un jeton d'accès dans la réponse. De plus, vous recevrez un jeton d'actualisation qui peut être utilisé pour obtenir un nouveau jeton d'accès une fois que le jeton actuel expire.
2. Actualiser le jeton d'accès
Si votre jeton d'accès expire, vous pouvez utiliser le jeton d'actualisation fourni pour en obtenir un nouveau avec cette commande :
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=$REFRESH_TOKEN
Remplacez $REFRESH_TOKEN par votre jeton d'actualisation. Mettez à jour votre jeton d'actualisation si la réponse en contient un nouveau.
3. Terminer la session
Pour vous déconnecter et invalider le jeton d'actualisation, utilisez :
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=$REFRESH_TOKEN \
--data-urlencode client_id=processing-api-client
Informations de facturation
Par défaut, l'API Transkribus utilise le système de crédit interne de Transkribus pour la facturation. Cependant, sur demande, un système de facturation à l'usage peut être convenu.