PythonでBuildVuマイクロサービスにアクセスする

はじめに

以下のチュートリアルでは、ホストされたBuildVuクラウドAPIを使用してPDFファイルをHTMLまたはSVGに変換する方法を説明します。使用できるサービスは次の通りです：

IDRsolutionsのトライアルおよびクラウドサブスクリプションサービス
独自のセルフホストBuildVuマイクロサービス

上記のサービスには通常のHTTPリクエストでアクセスできますが、このチュートリアルではREST API をシンプルなPythonラッパーで包んだオープンソースのPython IDRCloudClient を使用します。

前提条件

pipを使用して、以下のコマンドでIDRCloudClientパッケージをインストールします：

pip install IDRCloudClient

コード例

PDFファイルをHTMLまたはSVGに変換する基本的なコード例を以下に示します。設定オプションと高度な機能については下記を参照してください。

from IDRSolutions import IDRCloudClient

client = IDRCloudClient('https://cloud.idrsolutions.com/cloud/' + IDRCloudClient.BUILDVU)

try:
    result = client.convert(
        # token='Token', # IDRsolutionsのトライアルおよびクラウドサブスクリプションサービスに接続する場合のみ必要
        input=IDRCloudClient.UPLOAD, 
        file='/path/to/exampleFile.pdf'
    )
    outputURL = result['downloadUrl']

    client.downloadResult(result, 'path/to/output/dir')

    if outputURL is not None:
        print("Download URL: " + outputURL)

except Exception as error:
    print(error)

コールバックURLに結果を返す

BuildVuマイクロサービスは、変換完了時に変換のステータスを送信するコールバックURLを受け付けます。コールバックURLを使用することで、変換が完了したかを判断するためにサービスをポーリングする必要がなくなります。
コールバックURLは、以下のようにconvertメソッドに渡すことができます。

result = client.convert(
    # token='Token', # IDRsolutionsのトライアルおよびクラウドサブスクリプションサービスに接続する場合のみ必要
    input=IDRCloudClient.UPLOAD,
    callbackUrl='http://listener.url',
    file='/path/to/exampleFile.pdf'
)

設定オプション

BuildVu APIは、変換をカスタマイズするためのキーと値のペアを含む文字列化されたJSONオブジェクトを受け付けます。設定はconvertメソッドに渡す必要があります。PDFファイルをHTMLまたはSVGに変換するための設定オプションの完全なリストはこちらで確認できます。

settings='{"key":"value","key":"value"}'

URLによるアップロード

ローカルファイルをアップロードする代わりに、BuildVuマイクロサービスがダウンロードして変換を実行するURLを指定することもできます。これを行うには、convertメソッドのinputとfileの値を以下に置き換えます。

input=IDRCloudClient.DOWNLOAD
url='http://exampleURL/exampleFile.pdf'

認証の使用

PDFファイルをHTMLまたはSVGに変換するためにユーザー名とパスワードが必要な独自のBuildVuマイクロサービスをデプロイしている場合、変換ごとにそれらを提供する必要があります。これらは、以下のようにconvertメソッドにauthという名前の変数を渡すことで提供されます。

auth=('username', 'password'))

詳細情報

GitHub上のIDRCloudClient
Pypi上のIDRCloudClient
BuildVuマイクロサービスAPI
BuildVuマイクロサービスの使用