Watson での curl の使用例

curl ユーティリティーを使用すると、コマンド行から HTTP 要求を行うことができます。このユーティリティーは、 GET、 POST、およびその他の HTTP メソッドを使用する要求を行うための単純なインターフェースを提供します。これにより、要求ヘッダー、データ、およびその他の入力を渡すことができ、呼び出しが返すすべての応答ヘッダーとデータを表示することができます。 curl では REST API を実行するためのコードを作成する必要がないため、 IBM Watson® の資料では、 curl を使用して呼び出し例を示しています。

curl ユーティリティーは、Apple ® macOS® および Microsoft® Windows®の最新バージョンとともにデフォルトでインストールされます。

macOS、Windows、または Linux®での curl のインストールまたはリフレッシュについて詳しくは、 Install curlを参照してください。
curl とその全範囲の機能の使用について詳しくは、すべての curlを参照してください。

curl は、アプリケーション開発には推奨されません。

セキュア通信のための curl の使用

curl がシステムにインストールされているかどうかをテストするには、端末プロンプトで以下のコマンドを実行します。

curl -V

サポートされるプロトコルの中に https がリストされ、サポートされる機能の中に SSL (Secure Sockets Layer) または TLS (Transport Layer Security) がリストされている場合は、すべて設定されています。すべての IBM Watson Watson サービスは、クライアントとサーバーの間のセキュア接続にこれらの機能を使用します。認証、保全性、および機密性を確保するために、ローカル証明書ストアに対して接続要求が検証されます。

これらのプロトコルがリストされていない場合は、要求に対して自己署名証明書を使用できます。ただし、正常に接続するには、要求に --insecure オプションまたは -k オプションを含めることによって、SSL 検証を無効にする必要があります。

SSL 検証を有効にすることを強くお勧めします。 SSL を無効にすると、接続とデータのセキュリティーが危険にさらされます。 SSL を使用不可にするのは必要な場合のみで、機密情報ではないデータを使用する場合に限ります。できるだけ早く SSL を使用可能にするための手順を実行してください。

curl 要求の例

以下の例は、 curlの使用法を示しています。要求は Speech to Text サービスを使用して、 IBM Cloud® と IBM Cloud Pak® for Dataの両方で音声をテキストに書き起こします。

IBM Cloud

curl -X POST -u "apikey:{apikey}" \
--header "Content-Type: audio/flac" \
--data-binary ./audio-file.flac \
"{url}/v1/recognize"

IBM Cloud Pak for Data

curl -X POST \
--header "Authorization: Bearer {token}" \
--header "Content-Type: audio/flac" \
--data-binary ./audio-file.flac \
"{url}/v1/recognize"

どちらの例でも、 {url} をサービス・インスタンスの URL に置き換えます。認証は IBM Cloud®では異なります。では、 {apikey} をサービス・インスタンスの API キーに置き換え、 IBM Cloud Pak® for Dataでは、 {token} をサービス・インスタンス用に生成するアクセス・トークンに置き換えます。いずれかのプラットフォームでのサービスに対する認証について詳しくは、 Watson サービスに対する認証を参照してください。

資料内の例に基づいて要求を送信する場合は、例から中括弧 ({ }) を省略してください。これらは、実際の値に置き換える必要がある変数値を示しています。 Windows ユーザーは、各行の末尾にある円記号 (\) をキャレット (^) に置き換える必要があります。 \ または ^の後に末尾スペースがないことを確認します。