Verbindung zur Web Services API herstellen

Stellen Sie über SOAP-, JSON- oder POST-Anfragen eine Verbindung zur ABBYY FlexiCapture Web Services API her und authentifizieren Sie sich mit einem Windows- oder FlexiCapture-Konto.

Bevor Sie die API verwenden, stellen Sie eine Verbindung zu einem Webservice her. Eine Verbindung kann von der Rolle Scanning Operator (ID=1) Rolle auf dem Workstation-Typ User station (ID=10) Workstation-Typ hergestellt werden.

​

Anfrage-Schnittstellen

Sie können über SOAP-, JSON- oder POST-Anfragen mit der Web Services API des ABBYY FlexiCapture 12 Application Server arbeiten. Die Adresse des Webservice bestimmt, auf welche Schnittstelle Sie zugreifen.

Methode	Verwendung	Handler-Wert
SOAP-Anfragen	Beliebige Operation	.../API/v1/Soap
JSON-Anfragen	Beliebige Operation	.../API/v1/Json
POST-Anfragen	Dateioperationen, z. B. das Hochladen von Dateien auf den Server, das stückweise Hochladen von Dateien, das Abrufen einer Prüfsumme und das 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 mit einem ABBYY FlexiCapture-Konto nutzen.

Für ein Windows-Konto stehen Ihnen zwei Optionen zur Verfügung:

• Windows-Authentifizierung: NTLM oder Negotiate
• Basic-Authentifizierung, bei der Benutzername und Kennwort als Base64-codierte Zeichenfolge username:password übergeben werden

Fügen Sie für ein ABBYY FlexiCapture-Konto /FCAuth zur Webservice-URL hinzu. Verwenden Sie zunächst die Basic-Authentifizierung. Nach einem erfolgreichen Aufruf des Service enthält die Antwort einen AuthTicket-Header mit einem Autorisierungstoken. Verwenden Sie dieses Token für nachfolgende Anfragen vom selben Computer mit Bearer-Authentifizierung.

Um einen Mandanten anzugeben, fügen Sie das Suffix ?Tenant=MyTenantName am Ende der API-Verbindungsadresse hinzu.

​

Beispieladressen für Webservices

Anfragetyp	Windows-Konto	ABBYY FlexiCapture-Konto
SOAP-Anfragen	https://<ApplicationServer>/FlexiCapture12/Server/API/v1/Soap	https://<ApplicationServer>/FlexiCapture12/Server/FCAuth/API/v1/Soap
JSON-Anfragen	https://<ApplicationServer>/FlexiCapture12/Server/API/v1/Json	https://<ApplicationServer>/FlexiCapture12/Server/FCAuth/API/v1/Json
POST-Anfragen	https://<ApplicationServer>/FlexiCapture12/Server/FileService/v1	https://<ApplicationServer>/FlexiCapture12/Server/FCAuth/FileService/v1