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

はじめに

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

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

上記のサービスはプレーンなHTTPリクエストでアクセスできますが、このチュートリアルではREST API のシンプルなJavascriptラッパーを提供するオープンソースのJavascript IDRCloudClient を使用します。

前提条件

プロジェクトにクライアントを追加するには、idrcloudclient.jsファイルをプロジェクトに追加し、以下の行を含めてアクセスする必要があります：

<script src="path/to/idrcloudclient.js" type="text/javascript"></script>

コード例

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

var endpoint = 'https://cloud.idrsolutions.com/cloud/' + IDRCloudClient.BUILDVU;
var parameters =  { 
    //token: 'Token', //IDRsolutionsのトライアルおよびクラウドサブスクリプションサービスに接続する場合のみ必要
    input: IDRCloudClient.UPLOAD,
    file: 'path/to/exampleFile.pdf'
}

function progressListener(e) {
    console.log(JSON.stringify(e));
}

function failureListener(e) {
    console.log(e);
    console.log('Failed!');
}

function successListener(e) {
    console.log(JSON.stringify(e));
    console.log('Download URL: ' + e.downloadUrl);
}

IDRCloudClient.convert({
    endpoint: endpoint,
    parameters: parameters,
    
    // 以下は利用可能なリスナーです
    progress: progressListener,
    success: successListener,
    failure: failureListener
});

Javascriptクライアントを使用した例はこちらにあります。

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

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

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

設定オプション

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

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

URLによるアップロード

ローカルファイルをアップロードするだけでなく、BuildVuマイクロサービスがダウンロードして変換を実行するURLを指定することもできます。これを行うには、parameters変数のinputとfileの値を以下のように置き換える必要があります。

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

認証の使用

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

username: 'username',
password: 'password',

詳細情報

GitHub上のIDRCloudClient
IDRCloudClientオンライン例
 BuildVuマイクロサービスAPI
BuildVuマイクロサービスの使用