cURLを使ってBuildVu Microserviceにアクセスする
はじめに
以下のチュートリアルでは、ホストされたBuildVuクラウドAPIを使ってPDFファイルをHTMLやSVGに変換する方法を紹介します：
- IDRsolutionsのトライアルおよびクラウドサブスクリプションサービス
- あなた自身のセルフホストBuildVuマイクロサービス
上記のサービスはすべて、REST APIを使用してcURLでアクセスできます。
前提条件
この作業を始める前に、cURLがインストールされていることを確認する必要があります。セットアップはオペレーティング・システムによって異なりますが、詳細はcurlのウェブサイトを参照してください。
サンプルコード
PDFファイルをHTMLやSVGに変換する基本的なコード例です。
ファイルエントリーは、’@’の後にファイルへのパス（絶対パスまたは相対パス）を指定する必要があります。
設定オプションと詳細機能は下記にあります。
curl -X POST -F input="upload" -F file="@/path/to/file/myfile.pdf" https://cloud.idrsolutions.com/cloud/buildvu
# Variable token required when connecting to the IDRsolutions trial or cloud subscription servers, example below
curl -X POST -F input="upload" -F file="@/path/to/file/myfile.pdf" -F token=Token https://cloud.idrsolutions.com/cloud/buildvu
応答は uuid を含む JSON フォーマットで返されます。
{"uuid" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"}
変換の進行状況をポーリングすると、変換が完了したときに出力の URL を取得することができます。
curl https://cloud.idrsolutions.com/cloud/buildvu?uuid=aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa
応答はJSON形式で、以下の詳細が提供されます。
{
"state" : "processed",
"downloadUrl" : "output/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa/myfile.zip",
"previewUrl" : "output/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa/myfile/index.html"
}
ブラウザで出力をプレビューするには、previewURLを使用することができます。
downloadURL を使って変換された出力をダウンロードすることもできます。これは以下のcURLリクエストで実行できます。
# Download the file to the current directory as it is named, in this case "myfile.zip"
curl https://cloud.idrsolutions.com/cloud/buildvu/output/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa/myfile.zip -LO --output "output.zip"
コールバックURLへ結果を返す
BuildVu Microserviceは、完了時に変換ステータスを送信するコールバックURLを受け付けます。コールバックURLを使用すると、変換がいつ完了したかを判断するためにサービスをポーリングする必要がなくなります。
コールバックURLは以下のように指定します。
curl -X POST -F input="upload" -F callbackUrl="http://listener.url" -F file="@/path/to/file/myfile.pdf" https://cloud.idrsolutions.com/cloud/buildvu
# Variable token required when connecting to the IDRsolutions trial or cloud subscription servers, example below
curl -X POST -F input="upload" -F callbackUrl="http://listener.url" -F file="@/path/to/file/myfile.pdf" -F token=Token https://cloud.idrsolutions.com/cloud/buildvu
設定オプション
BuildVu APIは、変換をカスタマイズするためのキーバリューペア設定オプションを含む文字列化されたJSONオブジェクトを受け付けます。設定は、cURLコマンドのURLの前に追加する必要があります。PDFファイルをHTMLまたはSVGに変換するための設定オプションの完全なリストはこちらをご覧ください。
ダブルクォートをエスケープする構文は、使用する環境によって異なる場合があることに注意してください。あなたの環境に合ったものを確認してください：
PowerShellの場合、解析エラーを避けるために、コマンドは curl.exe --% で始まる必要があることに注意してください。
URLによるアップロード
ローカルファイルをアップロードするだけでなく、BuildVu Microserviceがダウンロードして変換を実行するURLを指定することもできます。そのためには、inputとfileの値を以下のように置き換えてください。
-F input=download -F url="http://exampleURL/exampleFile.pdf"
認証を使用する
PDFファイルをHTMLまたはSVGに変換するためにユーザー名とパスワードを必要とする独自のBuildVu Microserviceをデプロイした場合、変換のたびにユーザー名とパスワードを提供する必要があります。これらは、URLの前にユーザー名とパスワードを持つユーザーフラグを追加することで提供されます。
--user username:password