使用 API 建置自訂應用程式

使用 Discovery API 來建置自訂應用程式或元件，以搜尋您的資料。

服務 API 版本化

API 要求需要以 version=YYYY-MM-DD 格式採用日期的版本參數。每當發生與舊版不相容的 API 變更時，即會發行 API 的新次要版本。

請隨每一個 API 要求傳送版本參數。服務會使用您指定日期的 API 版本，或該日期之前的最新版本。不要預設為現行日期。請改為指定符合您應用程式相容版本的日期，而且在您的應用程式備妥可用於較新版本之前，請勿變更此日期。

目前的版本是 2023-03-31。

此資訊僅適用於 IBM Cloud。

要使用 API，您必須建構 URL，以便在您的要求中使用。許多 API 方法都需要專案 ID。

從 IBM Cloud 資源清單中，展開 AI/Machine Learning，然後尋找 Discovery 服務實例的服務頁面。
從認證區段中，複製 URL。您可以在 API 要求中指定此值作為 {url}。
當您在此頁面上時，請複製 API 金鑰。您指定此值為 {apikey}。
在 Discovery中開啟專案，然後跳至 整合並部署 > API 資訊 頁面。
複製專案 ID。您指定此值為 {project_id}。

如果您使用「內容採礦」專案，請停留在 共用鏈結 頁面上。從 Web 瀏覽器的位置欄位中，複製以 /projects 開頭的 URL。例如，projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta。在 URL 的 /projects/ 區段之後指定的 ID 是您的專案 ID。

使用您複製的 ID 建構請求 URL。

例如，下列要求列出專案中的集合:

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

若要取得 {collection_id}，您可以使用列出集合 API 方法。或者，在產品使用者介面中開啟集合，然後從 Web 瀏覽器位置欄位複製集合 ID (顯示在頁面 URL的 /collections/ 區段之後)。

此資訊僅適用於 Discovery for Cloud Pak for Data。

要使用 API，您必須建構 URL，以便在您的要求中使用。

從 Web 用戶端主功能表，展開「服務」，然後按一下「實例」。
尋找您的實例，然後按一下它以開啟其摘要頁面。
捲動至頁面的 存取資訊 區段，然後複製 URL。您將此值指定為 {url}。
另外也複製持有人記號。當您發出 API 呼叫時，需要傳遞此記號。
從已啟動的應用程式實例，移至 整合及部署 > API 資訊 頁面。
複製專案 ID。您將指定此值為 {project_id}。

如果您使用「內容採礦」專案，請停留在 共用鏈結 頁面上。從 Web 瀏覽器的位置欄位中，複製以 /projects 開頭的 URL。例如，projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta。在 URL 的 /projects/ 區段之後指定的 ID 是您的專案 ID。

使用您複製的 ID 建構請求 URL。

例如，下列要求列出專案中的集合:

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

為管理者產生的載送記號可以存取任何實例，而不論為實例配置的存取設定為何。

不記名代用幣在 12 小時後失效。如需自訂階段作業長度的相關資訊，請參閱設定閒置階段作業逾時值。

開發人員可以進行下列加強功能: