JavascriptでPDFを画像に変換する

はじめに

以下のチュートリアルでは、ホストされたJPedalクラウドAPIを使用してPDFを画像に変換する方法を説明します。独自のセルフホスト型JPedalマイクロサービスをセットアップすることもできます。

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

前提条件

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

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

コード例

以下はPDFを画像に変換するための基本的なコード例です。設定オプションと高度な機能については以下をご覧ください。

var endpoint = 'https://my-self-hosted-service.com/' + IDRCloudClient.JPEDAL;
var parameters =  { 
    input: IDRCloudClient.UPLOAD,
    file: 'path/to/exampleFile.pdf',
    settings: '{"mode":"convertToImages","format":"png"}'
}

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,
    
    // The below are the available listeners
    progress: progressListener,
    success: successListener,
    failure: failureListener
});

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

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

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

var parameters =  {
    input: IDRCloudClient.UPLOAD,
    callbackUrl: 'http://listener.url',
    file: 'path/to/exampleFile.pdf',
    settings: '{"mode":"convertToImages","format":"png"}'
}

設定オプション

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

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

URLによるアップロード

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

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

認証の使用

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

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

詳細情報

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