開始使用 Looker API

Looker API 是安全的「RESTful」應用程式設計介面,可用於管理 Looker 例項,並透過 Looker 資料平台擷取資料。您可以使用 Looker API 編寫應用程式或自動化指令碼,以便佈建新的 Looker 使用者帳戶、執行查詢、安排資料提交作業等。您幾乎可以透過 Looker API 執行所有 Looker 應用程式功能。

Looker API 路徑和通訊埠

透過 Looker 執行個體的 API 網址存取 API。

Looker 管理員可以透過「管理」>「API」頁面中的「API 主機網址欄位,以以下格式指定 API 路徑:

https://<instance_name>.cloud.looker.com

Looker 管理員也可以使用 API 主機網址欄位,指派與 Looker 伺服器機器名稱不同的 API 路徑。舉例來說,如果 Looker 安裝位置位於負載平衡器後方,就會發生這種情況。在這種情況下,請與 Looker 管理員聯絡,瞭解您的 API 路徑。

如果 Looker 管理員未指定 API 主機網址欄位,Looker 會使用預設的 API 路徑。對於在 Google Cloud、Microsoft Azure 和 Amazon Web Service (AWS) 託管的 Looker 執行個體,如果是在 2020 年 7 月 7 日當天或之後建立,預設 Looker API 路徑會使用 443 連接埠。對於在 AWS 上託管的 Looker 執行個體,如果是在 2020 年 7 月 7 日前建立,預設 Looker API 路徑會使用 19999 通訊埠。預設的 API 網址格式如下:

https://<instance_name>.cloud.looker.com:<port>

用戶端 SDK

您可以將 Looker API 與任何可提出 HTTPS 要求及處理 JSON 回應的程式設計語言或應用程式環境搭配使用。您可以使用 curl (或同等工具)、Looker Ruby SDK,或為所選語言產生用戶端 SDK 程式庫,手動建構 Looker API HTTPS 要求。我們建議您使用 SDK,因為它會為您處理驗證和 HTTPS 要求的詳細資料,讓您可以透過簡單的函式呼叫來呼叫 Looker API。

如需 SDK 詳細資料,請參閱 Looker API SDK 說明文件頁面。

驗證

Looker 會在要求的 HTTP 授權標頭中使用 OAuth 2.0 載具存取權憑證,驗證 API 要求。所有 Looker API 端點都需要安全的 HTTPS 連線,才能確保存取權杖在傳輸過程中安全無虞。

這項操作的步驟取決於您是否使用 SDK。如需詳細操作說明,請參閱 Looker API 驗證說明文件頁面。

互動式 API 說明文件

如需 API 參考資料說明文件,請前往 Looker Marketplace 下載 API Explorer 擴充功能。詳情請參閱「使用 API Explorer」說明文件。如果您是 Looker 管理員,也可以在 Looker 的 API 管理員頁面中,按一下「Use API Explorer」連結,存取 API Explorer。

版本管理

建構應用程式時,API 穩定性是一項重要考量。為協助您瞭解哪些端點日後可能會變更,哪些端點應保持穩定,我們會將特定端點標示為 Beta 版。詳情請參閱 Looker API 版本控制說明文件頁面。