Zum Hauptinhalt springen
Die REST API stellt die folgenden Methoden zum Abrufen der Reporting-Daten bereit:
Sie müssen sich für jede Anfrage mit einem Bearer-Token authentifizieren, das über eine Anfrage an den ABBYY FlexiCapture Application Server abgerufen wird. Nur der Administrator oder Monitoring Operator des Mandanten darf auf die Daten dieses Mandanten zugreifen.
Sie können die API-Beschreibung auch unter http://localhost:8002 auf jedem Rechner aufrufen, auf dem der Datenzugriff des ABBYY FlexiCapture Reporting Service installiert ist.

Beispielskript

Das folgende PowerShell-Skript lädt ein Archiv mit Reporting-Statistiken für einen bestimmten Mandanten und Zeitraum herunter und verwendet zur Authentifizierung ein ABBYY FlexiCapture-Konto.
# Lädt ein Archiv mit Reporting-Statistiken für den angegebenen Mandanten herunter
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]$ReportingServiseUri
    )
    # Mandantenname und Application Server-Adresse aus den Funktionsparametern verwenden
    $URI = "https://$AppServer/Flexicapture12/Server/FCAuth/API/wsdl?Tenant=$TenantName"
    # PSCredential-Objekt mit dem angegebenen Benutzernamen und Kennwort erstellen
    $creds = New-Object System.Management.Automation.PSCredential -ArgumentList @($user,(ConvertTo-SecureString -String $password -AsPlainText -Force))
    # Proxy-Webdienst erstellen, der sich mit diesen Anmeldeinformationen authentifiziert
    $proxy = New-WebServiceProxy -Uri $URI -Credential $creds
    $proxy.Url = "https://$AppServer/flexicapture12/Server/FCAuth/API/Soap?Tenant=$TenantName"
    $proxy.Credentials = $creds
    # Damit das Token von der FlexiCapture-API anfordern
    $ticket = $proxy.GetCurrentUserAuthTicket()
    $nameFile = $year.ToString() + "-" + $month.ToString()
    # Pfad für die herunterzuladende Datei erstellen
    $path = "$DownloadPath\$nameFile.zip"
    # Anforderung mit Bearer-Authentifizierungsheader erstellen, der das Token enthält,
    # und an den Reporting-Datenzugriffs-Service senden, um das Archiv für den angegebenen Mandanten und Zeitraum abzurufen
    $headers = @{ Authorization = "Bearer " + $ticket}
    Invoke-RestMethod -Uri $ReportingServiseUri"?tenantName=$TenantName&year=$year&month=$month" -Headers $headers -OutFile $path
}
GetDataFile