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=@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=@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を使用すると、出力をブラウザでプレビューすることができます。
また、変換後の出力は、ダウンロードURLを用いてダウンロードすることができます。これは、以下の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
# Download the file to the current directory with your own name, in this example we save it as output.zip
curl 'https://cloud.idrsolutions.com/cloud/buildvu/output/=aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa/myfile.zip' -Lo 'output.zip'
コンフィグレーションオプション
BuildVu APIは変換をカスタマイズするためのキーバリューペア設定オプションを含む文字列化されたJSONオブジェクトを受け付けます。設定はcURLコマンドのURLの前に追加する必要があります。PDFファイルをHTMLやSVGに変換するための設定オプションの全リストはこちらでご覧になれます。
なお、ダブルクォートのエスケープの構文は、使用する環境によって異なる場合がありますので、ご自分の環境に合ったものを確認してください。
Bash:
-F 'settings={"key":"value","key":"value"}'
PowerShell:
-F 'settings={"""key""":"""value""","""key""":"""value"""}'
URLでアップロード
ローカルファイルをアップロードするだけでなく、URLを指定してBuildVu Microserviceがダウンロードし、変換を実行することも可能です。この場合、inputとfileの値を以下のように置き換えてください。
-F 'input=download' -F 'url=http://exampleURL/exampleFile.pdf'
認証の利用について
PDFファイルをHTMLやSVGに変換するためにユーザー名とパスワードを必要とする独自のBuildVu Microserviceをデプロイしている場合、変換毎にユーザー名とパスワードを提供する必要があります。これらは、URLの前にユーザ名とパスワードの入ったユーザフラグを追加することで提供されます。
--user username:password
詳しくはこちら
Offical cURL website
BuildVu Microservice API
BuildVu Microservice Use