Web Services API に接続する - ABBYY Documentation

API を使用する前に、Web サービスに接続します。この接続を確立できるのは、User station (ID=10) ワークステーションタイプ上の Scanning Operator (ID=1) ロールです。

リクエストインターフェイス

ABBYY FlexiCapture 12 Application Server の Web Services API は、SOAP リクエスト、JSON リクエスト、または POST リクエストを使用して利用できます。アクセスするインターフェイスは、Web サービスのアドレスによって決まります。

メソッド	使用する場合	ハンドラー値
SOAP リクエスト	任意の操作	`.../API/v1/Soap`
JSON リクエスト	任意の操作	`.../API/v1/Json`
POST リクエスト	サーバーへのファイルのアップロード、ファイルの分割アップロード、チェックサムの取得、サーバーからのファイルのダウンロードなどのファイル操作	`.../FileService/v1`

認証方法

ABBYY FlexiCapture 12 では、Windows アカウントまたは ABBYY FlexiCapture アカウントを使用して Web Services API に接続できます。 Windows アカウントでは、次の 2 つの方法を使用できます。

Windows 認証: NTLM または Negotiate
Basic 認証: ユーザー名とパスワードを Base64 エンコードした文字列 username:password として渡す

ABBYY FlexiCapture アカウントでは、Web サービス URL に /FCAuth を追加します。まず Basic 認証を使用します。サービスの呼び出しに 1 回成功すると、レスポンスに認可トークンを含む AuthTicket ヘッダーが返されます。同じマシンから送信する以降のリクエストでは、Bearer 認証でそのトークンを使用します。

tenant を指定するには、API 接続アドレスの末尾に ?Tenant=MyTenantName を追加します。

Web サービスのアドレス例

リクエストの種類	Windows アカウント	ABBYY FlexiCapture アカウント
SOAP リクエスト	`https://<ApplicationServer>/FlexiCapture12/Server/API/v1/Soap`	`https://<ApplicationServer>/FlexiCapture12/Server/FCAuth/API/v1/Soap`
JSON リクエスト	`https://<ApplicationServer>/FlexiCapture12/Server/API/v1/Json`	`https://<ApplicationServer>/FlexiCapture12/Server/FCAuth/API/v1/Json`
POST リクエスト	`https://<ApplicationServer>/FlexiCapture12/Server/FileService/v1`	`https://<ApplicationServer>/FlexiCapture12/Server/FCAuth/FileService/v1`