IBM Cloud Docs
API を使用したカスタム・アプリケーションの作成

API を使用したカスタム・アプリケーションの作成

Discovery API を使用して、データを検索するカスタム・アプリケーションまたはコンポーネントを作成します。

サービス API のバージョン管理

API 要求には、version=YYYY-MM-DD という形式で日付を設定する version パラメーターが必要です。 後方互換性のない API 変更が発生するたびに、新しいマイナー・バージョンの API がリリースされます。

API 要求ごとに version パラメーターを送信します。 本サービスでは、指定された日付の API バージョン、またはその日付より前の最新のバージョンが使用されます。 現在日付をデフォルトに設定しないでください。 代わりに、ご使用のアプリと互換性のあるバージョンに一致する日付を指定し、より新しいバージョン用にアプリの準備ができるまでその日付を変更しないでください。

現在のバージョンは 2023-03-31 です。

プロジェクト ID の取得 IBM Cloud

この情報は IBM Cloud にのみ適用されます。

API を使用するには、リクエストで使用する URL を構築する必要があります。 API メソッドの多くは、プロジェクト ID を必要とします。

  1. IBM Cloud リソース・リストから、 「AI/Machine Learningを展開し、Discovery サービス・インスタンスのサービス・ページを見つけます。

  2. 「資格情報」 セクションで、 URLをコピーします。 この値は、API 要求で {url} として指定します。

  3. このページが表示されている間に、API キーをコピーします。 この値は {apikey} として指定します。

  4. Discoveryでプロジェクトを開き、 「統合とデプロイ」 > 「API 情報」 ページに移動します。

  5. プロジェクト ID をコピーします。 この値は {project_id} として指定します。

    コンテンツ・マイニング・プロジェクトを使用している場合は、 「リンクの共有」 ページにとどまります。 Web ブラウザーの 「ロケーション」 フィールドから、 /projects で始まる URL をコピーします。 例えば、projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/betaです。 URL の /projects/ セグメントの後に指定される ID は、プロジェクト ID です。

  6. コピーしたIDを使用して、 URL にリクエストを作成します。

    例えば、以下の要求は、プロジェクト内のコレクションをリストします。

    curl -X {request_method} -u "apikey:{apikey}" \
"{url}/v2/projects/{project_id}/collections?version=2019-11-29 -k"

{collection_id} を取得するには、 コレクションのリスト API メソッドを使用できます。 あるいは、製品ユーザー・インターフェースでコレクションを開き、Web ブラウザーのロケーション・フィールドから、ページ URLの /collections/ セグメントの後に表示されるコレクション ID をコピーします。

APIの使用 IBM Cloud Pak for DataIBM Software Hub

この情報は Discovery for Cloud Pak for Data にのみ適用されます。

API を使用するには、リクエストで使用する URL を構築する必要があります。

  1. ウェブクライアントのメインメニューから 、「サービス」 を展開し 、「インスタンス」 をクリックします。

  2. インスタンスを見つけてクリックし、サマリー・ページを開きます。

  3. ページの 「アクセス情報」 セクションまでスクロールし、 URLをコピーします。 この値は、{url} として指定します。

  4. ベアラー・トークンもコピーします。 API 呼び出しを行う際、このトークンを渡す必要があります。

  5. 起動されたアプリケーション・インスタンスから、 「統合とデプロイ」 > 「API 情報」 ページに移動します。

  6. プロジェクト ID をコピーします。 この値は {project_id} として指定します。

    コンテンツ・マイニング・プロジェクトを使用している場合は、 「リンクの共有」 ページにとどまります。 Web ブラウザーの 「ロケーション」 フィールドから、 /projects で始まる URL をコピーします。 例えば、projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/betaです。 URL の /projects/ セグメントの後に指定される ID は、プロジェクト ID です。

  7. コピーしたIDを使用して、 URL にリクエストを作成します。

    例えば、以下の要求は、プロジェクト内のコレクションをリストします。

    curl -H "Authorization: Bearer {token}" \
"{url}/v2/projects/{project_id}/collections?version=2019-11-29 -k"

管理者用に生成されたベアラー・トークンは、インスタンスに対して構成されているアクセス設定に関係なく、どのインスタンスにもアクセスできます。

無記名トークンは12時間で期限切れとなります。 セッションの長さのカスタマイズについて詳しくは、 アイドル・セッション・タイムアウトの設定を参照してください。

次のステップ

開発者は、以下の機能拡張を行うことができます。