Zum Hauptinhalt springen
Um eine API zu verwenden, müssen Sie zunächst eine Verbindung zu einem Webservice herstellen. Eine Verbindung kann von der Rolle „Scanning Operator“ (ID=1) Rolle auf dem Workstation-Typ „User station“ (ID=10) Workstation-Typ hergestellt werden.

​
Die APIs

Sie können mit der Web Services API des ABBYY FlexiCapture 12 Application Server entweder über SOAP-Anfragen, JSON-Anfragen oder POST-Anfragen arbeiten. Welche Schnittstelle verwendet wird, hängt von der Adresse des Webservice ab:
MethodeVerwendungHandler-Wert
SOAP-AnfragenFür jede Operation geeignet…/API/v1/Soap
JSON-AnfragenFür jede Operation geeignet…/API/v1/Json
POST-AnfragenGeeignet zur Optimierung von Dateivorgängen, z. B. zum Hochladen von Dateien auf den Server, zum stückweisen Hochladen von Dateien, zum Abrufen einer Prüfsumme oder zum Herunterladen von Dateien vom Server…/FileService/v1

​
Authentifizierungsmethoden

In ABBYY FlexiCapture 12 können Sie die Web Services API entweder mit einem Windows-Konto oder einem ABBYY FlexiCapture-Konto verwenden. Für ein Windows-Konto haben Sie zwei Optionen:
  • Windows-Authentifizierung: NTLM oder Negotiate
  • Basic-Authentifizierung, bei der Benutzername und Kennwort als Base64-codierter String „username:password“ übergeben werden
Für ein ABBYY FlexiCapture-Konto fügen Sie der Webservice-URL „/FCAuth“ hinzu. Verwenden Sie zunächst die Basic-Authentifizierung. Nach einem erfolgreichen Aufruf des Service enthält die Antwort einen AuthTicket-Header mit einem Autorisierungstoken, den Sie für nachfolgende Anfragen vom selben Rechner mit Bearer-Authentifizierung verwenden können.
Fügen Sie das Suffix in Form von ?Tenant=MyTenantName am Ende der API-Verbindungsadresse hinzu, um einen Mandanten anzugeben.
Windows-KontoABBYY FlexiCapture-Konto
SOAP-Anfragenhttps:// <ApplicationServer>/FlexiCapture12/Server/API/v1/Soaphttps:// <ApplicationServer>/FlexiCapture12/Server/FCAuth/API/v1/Soap
JSON-Anfragenhttps:// <ApplicationServer>/FlexiCapture12/Server/API/v1/Jsonhttps:// <ApplicationServer>/FlexiCapture12/Server/FCAuth/API/v1/Json
POST-Anfragenhttps:// <ApplicationServer>/FlexiCapture12/Server/FileService/v1https:// <ApplicationServer>/FlexiCapture12/Server/FCAuth/FileService/v1