メインコンテンツへスキップ
API を使用するには、まず Web サービスに接続する必要があります。この接続を確立できるのは、「User station」(ID=10) ワークステーション タイプ 上の「Scanning Operator」(ID=1) ロール です。

API

ABBYY FlexiCapture 12 Application Server の Web Services API は、SOAP リクエスト、JSON リクエスト、または POST リクエストを使用して利用できます。アクセス先のインターフェイスは、Web サービスのアドレスによって決まります。
メソッド使用する場合Handler 値
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 認証: username と password を Base64 エンコードした文字列 "username:password" として渡します
ABBYY FlexiCapture アカウントの場合は、Web サービス URL に “/FCAuth” を追加します。最初は Basic 認証を使用してください。service の呼び出しが 1 回正常に完了すると、応答には認可トークンを含む AuthTicket ヘッダーが返されます。このトークンは、同じマシンからの後続の request で Bearer 認証を使用する際に利用できます。
tenant を指定するには、API 接続アドレスの末尾に ?Tenant=MyTenantName 形式のサフィックスを追加します。
Windows アカウントABBYY FlexiCapture アカウント
SOAP リクエストhttps:// <ApplicationServer>/FlexiCapture12/Server/API/v1/Soaphttps:// <ApplicationServer>/FlexiCapture12/Server/FCAuth/API/v1/Soap
JSON リクエストhttps:// <ApplicationServer>/FlexiCapture12/Server/API/v1/Jsonhttps:// <ApplicationServer>/FlexiCapture12/Server/FCAuth/API/v1/Json
POST リクエストhttps:// <ApplicationServer>/FlexiCapture12/Server/FileService/v1https:// <ApplicationServer>/FlexiCapture12/Server/FCAuth/FileService/v1