cURLを使用してBuildVuマイクロサービスにアクセスする
このチュートリアルでは、ホストされた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
# IDRsolutionsトライアルまたはクラウドサブスクリプションサーバーに接続する際に必要な変数token、以下に例を示します
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"}
このuuidを使用して、変換の進行状況をポーリングし、変換が完了したら出力の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を使用して、ブラウザで出力をプレビューできます。
また、ダウンロードURLを使用して変換された出力をダウンロードすることもできます。これは次のcURLリクエストで実行できます。
# ファイルを現在のディレクトリにその名前のままダウンロードします。この場合は「myfile.zip」
curl https://cloud.idrsolutions.com/cloud/buildvu/output/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa/myfile.zip -LO --output "output.zip"
BuildVuマイクロサービスは、変換完了時に変換のステータス
を送信するためのコールバック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
# IDRsolutionsトライアルまたはクラウドサブスクリプションサーバーに接続する際に必要な変数token、以下に例を示します
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 --%で始める必要があることに注意してください。
ローカルファイルをアップロードする以外に、BuildVuマイクロサービスがダウンロードして変換を実行するURLを提供することもできます。これを行うには、inputとfileの値を以下のように置き換える必要があります。
-F input=download -F url="http://exampleURL/exampleFile.pdf"
PDFファイルをHTMLまたはSVGに変換するためにユーザー名とパスワードを必要とする独自のBuildVuマイクロサービスをデプロイした場合、各変換時にそれらを提供する必要があります。これらは、URLの前にユーザー名とパスワードを含むuserフラグを追加することで提供されます。
--user username:password