Accès aux données de l’API REST - ABBYY Documentation

L’API REST permet de récupérer les données de reporting à l’aide de trois méthodes.

Authentifiez chaque requête à l’aide d’un jeton Bearer obtenu auprès du serveur d’applications ABBYY FlexiCapture. Seul l’Administrateur ou le Monitoring Operator du tenant peut accéder aux données de ce tenant.

Pour plus d’informations, consultez Authentification.

Méthodes disponibles

Méthode	Objectif
Méthode DataFile	Télécharge l’archive contenant les statistiques de reporting d’un tenant pour une période donnée.
Méthode DataFile/GetFileList	Répertorie toutes les archives existantes d’un tenant.
Méthode DataFile/CreateFile	Recrée l’archive d’une période lorsqu’un export a échoué.

Consulter la description de l’API

Ouvrez http://localhost:8002 sur toute machine où le composant d’accès aux données du service ABBYY FlexiCapture Reporting est installé.

Exemple de script

Le script PowerShell suivant télécharge une archive de statistiques de reporting pour un tenant et une période donnés, en s’authentifiant à l’aide d’un compte ABBYY FlexiCapture.

# Télécharge une archive contenant les statistiques de reporting pour le tenant spécifié
function GetDataFile {
    Param (
        [Parameter(Mandatory=$true)][String]$AppServer,
        [Parameter(Mandatory=$true)][AllowEmptyString()][string]$TenantName,
        [Parameter(Mandatory=$true)][string]$User,
        [Parameter(Mandatory=$true)][string]$Password,
        [Parameter(Mandatory=$true)][Int]$Year,
        [Parameter(Mandatory=$true)][Int]$Month,
        [Parameter(Mandatory=$true)][string]$DownloadPath,
        [Parameter(Mandatory=$true)][string]$ReportingServiceUri
    )
    # Utilise le nom du tenant et l'adresse du serveur d'applications transmis dans les paramètres de la fonction
    $URI = "https://$AppServer/Flexicapture12/Server/FCAuth/API/wsdl?Tenant=$TenantName"
    # Crée un objet PSCredential avec le nom d'utilisateur et le mot de passe fournis
    $creds = New-Object System.Management.Automation.PSCredential -ArgumentList @($User,(ConvertTo-SecureString -String $Password -AsPlainText -Force))
    # Crée un service web proxy qui s'authentifiera avec ces identifiants
    $proxy = New-WebServiceProxy -Uri $URI -Credential $creds
    $proxy.Url = "https://$AppServer/flexicapture12/Server/FCAuth/API/Soap?Tenant=$TenantName"
    $proxy.Credentials = $creds
    # Et l'utilise pour demander le jeton à l'API FlexiCapture
    $ticket = $proxy.GetCurrentUserAuthTicket()
    $nameFile = $Year.ToString() + "-" + $Month.ToString()
    # Crée le chemin d'accès au fichier téléchargé
    $path = "$DownloadPath\$nameFile.zip"
    # Crée une requête avec l'en-tête d'authentification Bearer contenant le jeton,
    # et l'envoie au service d'accès aux données de reporting pour récupérer l'archive
    # du tenant et de la période spécifiés
    $headers = @{ Authorization = "Bearer " + $ticket}
    Invoke-RestMethod -Uri $ReportingServiceUri"?tenantName=$TenantName&year=$Year&month=$Month" -Headers $headers -OutFile $path
}
GetDataFile