cURL コマンドは、URL を使用してデータを転送する優れた方法です。コマンド ライン ターミナルから API を使用する場合は、cURL コマンドを使用することをお勧めします。通常のリクエストを実行できるだけでなく、フォーム データの投稿、ユーザーの認証、ファイルへの応答の保存、その他の関連するファイル操作操作も実行できます。簡単に言うと、curl は、ユーザーの介入なしに動作するように設計された、サーバーとの間でデータを転送するためのコマンド ライン ユーティリティです。curl を使用すると、HTTP、HTTPS、SCP、SFTP、FTP などのサポートされているプロトコルのいずれかを使用して、データをダウンロードまたはアップロードできます。
それにもかかわらず、RESTfull API のテストも容易になります。
使用されるcURLコマンド
得る
HTTP を使用して行われる最も単純で一般的なリクエスト/操作は、URL を取得することです。このコマンドを使用すると、リクエストを送信し、特定の URL (この場合はドキュメント) からリソースを取得します。
役職
デフォルトのリクエストは GET ですが、フォーム データの送信に同じ cURL コマンドを使用する必要がある場合は、POST リクエストを使用する必要があります。したがって、この記事では、テキスト コンテンツの送信に同じ POST コマンドを使用します。データを投稿するには、cURL コマンドで -d (または –data) パラメータを使用することに注意してください。
置く
既存のデータを更新する必要がある場合、その目的のために PUT メソッドが使用されます。この要件を満たすには、cURL コマンドで -X PUT を使用する必要があります。ここで、X は大文字にする必要があります。
詳細については、cURL チュートリアル をご覧ください。
注意: cURL コマンドを使用する場合は、バックスラッシュ \ の後に余分なスペースを入れないようにしてください。そうしないと、コマンドは実行されず、エラーが表示されます。
Mac で cURL を設定する
この記事では、macOS で cURL コマンドを使用して、ターミナル アプリケーションを使用して MS Word ドキュメント内にヘッダー フッター オブジェクトを挿入および更新します。そのため、開始するには、まず macOS に cURL をインストールする必要があります。ランチパッドから [その他] カテゴリの [ターミナル] アプリケーションを開くか、Command+Space を押して「ターミナル」と入力し、Enter/Return キーを押します。cURL をインストールする最も簡単な方法は Homebrew を使用することです。そのため、まず、Mac マシンに Homebrew をセットアップする必要があります。コマンド ライン ターミナルで次のコマンドを入力し、Enter キーを押します。
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null
次のコマンドを使用して、cURL 用の brew パッケージを取得します。
brew install curl
完了です。これで curl が使用できるようになりました。
Aspose.Cloud アカウントを承認する
Aspose.Cloud API を使い始めるには、まずアカウントを認証し、応答として JWT を取得します。アカウントをお持ちでない場合は、Aspose.Cloud ダッシュボード で作成するか、既存の Google アカウントまたは GitHub アカウントでサインアップして、Cloud API を使い始めることができます。
// First get JSON Web Token for authentication
// Get App Key and App SID from https://dashboard.aspose.cloud/
curl -v "https://api.aspose.cloud/connect/token" \
-X POST \
-d "grant_type=client_credentials&client_id=[APP_SID]&client_secret=[APP_KEY]" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"
Aspose.Words クラウド
Aspose は MS Word 文書を操作するための API を提供しており、Word 文書を処理するには クラウド API、オンプレミス API、クロスプラットフォーム アプリ のいずれかを使用できます。このブログでは、クラウドで MS Word 文書を作成、操作、変換する機能を提供するクラウド API に重点を置いています。MS Word ファイルの操作には、特定のソフトウェアのダウンロードやインストールは必要ありません。
Aspose.Cloud 製品ファミリーは、.NET、Java、PHP、Python、Node.js、Android、C++、Ruby、Swift、Go などの一般的なプログラミング言語を対象としたクラウド SDK のセットを提供します。これらの SDK はすべて Aspose.Words Cloud REST API のラッパーであり、cURL コマンドはコマンドプロンプト/ターミナル経由で REST API にアクセスする最もシンプルで簡単な方法の 1 つです。
このブログでは、Aspose.Words Cloud APIにアクセスしながら、cURLコマンドを使用してMS Wordファイル内のヘッダーとフッターのセクションを操作することに重点を置いています。
Word文書をアップロード
認証が完了したら、次のステップはファイルをクラウド ストレージにアップロードすることです。次の cURL コマンドを使用すると、ファイルは InputFolder の下のデフォルト ストレージにアップロードされます。
curl -v -X PUT "https://api.aspose.cloud/v4.0/words/storage/file/InputFolder" \
-H "accept: application/json" \
-H "authorization: Bearer <jwt token>" \
-F document=@BusinessLetter2.docx
ファイルがクラウド ストレージにアップロードされたときの成功メッセージ。
ここで、クラウド ストレージにファイルが存在することを確認するために、dashboard.aspose.cloud の [マイ ファイル] タブを開くと、BusinessLetter2.docx を含む InputFolder という名前の新しいフォルダーがリストに表示されていることがわかります。
ヘッダーオブジェクトを挿入
ドキュメントをアップロードした後、新しいヘッダーまたはフッター オブジェクトを挿入するか、既存のオブジェクトにアクセスしてそのプロパティを更新することができます。現在、Aspose.Words Cloud API は次の種類のヘッダーおよびフッター オブジェクトをサポートしています。
次のコマンドは、InputFolder の下のクラウド ストレージで既に使用可能な Word 文書内に HeaderFirst オブジェクトを挿入する方法を示しています。
curl -v -X PUT "https://api.aspose.cloud/v4.0/words/BusinessLetter2.docx/headersfooters?folder=InputFolder" \
-H "accept: multipart/form-data" \
-H "authorization: Bearer <jwt token>" \
-d "'HeaderFirst'" \
-H "Content-Type: application/json"
上記のコマンドを実行すると、コンソールに Word 文書内のセクションが一覧表示されます。
ヘッダーとフッターのセクションには通常、テキストや画像などが含まれており、次のコマンドでは、上記で作成したヘッダー オブジェクト内の最初の段落にサンプル テキストを挿入します。
curl -v -X POST "https://api.aspose.cloud/v4.0/words/BusinessLetter2.docx/sections/0/headersFooters/1/paragraphs?folder=InputFolder" \
-H "accept: multipart/form-data" \
-H "authorization: Bearer <jwt token>" \
-d "{ 'Text': 'Aspose.Words Cloud .NET SDK' }" \
-H "Content-Type: application/json"
ヘッダーオブジェクトのテキスト書式を更新する
テキストを挿入したら、テキストのフォント プロパティを更新できます。Word 文書には多数のテキスト インスタンスが含まれている可能性があるため、テキストを更新するには正確なパスを指定する必要があります。したがって、sections/0/headersfooters/1/paragraphs/0/runs/0 に挿入された上記の挿入テキストのフォント プロパティを更新する必要がある場合は、次のコマンドを使用する必要があります。
すでに配置されているオブジェクトのフォント プロパティを更新するので、PUT コマンドを使用する必要があることに注意してください。
curl -v -X PUT "https://api.aspose.cloud/v4.0/words/BusinessLetter2.docx/sections/0/headersFooters/1/paragraphs/0/runs/0/font?folder=InputFolder" \
-H "accept: multipart/form-data" \
-H "authorization: Bearer <jwt token>" \
-d "{ 'Bold':true, 'Size': 21.0, 'Name': 'Calibri', 'Color': { 'Web': '#f54269', 'Alpha': 0 } }" \
-H "Content-Type: application/json"
フッターにページ番号を挿入する
ヘッダー オブジェクトとフッター オブジェクトの重要な用途の 1 つは、ページ番号情報を表示することです。Aspose.Words Cloud を使用すると、この要件を簡単に実現できます。API には、PageNumber スタンプを表示する場所を指定する機能も用意されています。以下のコマンドに示すように、ページの右上にレンダリングされる PageNumber 情報を追加し、ドキュメントの最初のページ上に表示するように指定しています。
curl -v -X PUT "https://api.aspose.cloud/v4.0/words/BusinessLetter2.docx/PageNumbers?folder=InputFolder" \
-H "accept: multipart/form-data" \
-H "authorization: Bearer <jwt token>" \
-d "{ 'Format': '{PAGE} of {NUMPAGES}', 'Alignment': 'right', 'IsTop': false, 'SetPageNumberOnFirstPage': true }" \
-H "Content-Type: application/json"
Header インスタンスのフォント プロパティの更新と同様に、PageNumber 情報を含む Footer オブジェクトのフォント プロパティも更新できます。ページ番号情報は 3 つの実行オブジェクト (runs/0、runs/2、runs/3) で構成されているため、実行インスタンスごとにフォント更新コマンドを 3 回更新する必要があります。
curl -v -X PUT "https://api.aspose.cloud/v4.0/words/BusinessLetter2.docx/sections/0/headersFooters/3/paragraphs/1/runs/3/font?folder=InputFolder" \
-H "accept: multipart/form-data" \
-H "authorization: Bearer <jwt token>" \
-d "{ 'Bold':true, 'Size': 21.0, 'Name': 'Arial', 'Shadow': true, 'Color': { 'Web': '#f5b642', 'Alpha': 0 } }" \
-H "Content-Type: application/json"
上記のコマンドをすべて実行すると、結果のドキュメントは上記のプレビューのようになります。
参考までに、サンプル文書も添付します。