Looker API 是安全的「RESTful」應用程式設計介面,可透過 Looker 資料平台管理 Looker 執行個體及擷取資料。您可以使用 Looker API 編寫應用程式或自動化指令碼,佈建新的 Looker 使用者帳戶、執行查詢、排定資料傳送時間等。您幾乎可以在 Looker 應用程式中執行的所有操作,都能透過 Looker API 達成。
Looker API 路徑和通訊埠
透過 API 網址存取 Looker 執行個體的 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 上代管的 Looker 執行個體,以及在 2020 年 7 月 7 日當天或之後建立的 Amazon Web Service (AWS) 代管執行個體,預設 Looker API 路徑會使用 443 連接埠。對於在 2020 年 7 月 7 日之前建立的 AWS 代管 Looker 執行個體,預設 Looker API 路徑會使用 19999 連接埠。預設 API 網址格式如下:
https://<instance_name>.cloud.looker.com:<port>
用戶端 SDK
您可以使用 Looker API,透過任何可發出 HTTPS 要求及處理 JSON 回應的程式設計語言或應用程式環境,手動建構 Looker API HTTPS 要求 (使用 curl 或類似工具),或使用 Looker Ruby SDK,或為您選擇的語言產生用戶端 SDK 程式庫。建議您使用 SDK,因為 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 管理頁面」上,按一下「使用 API Explorer」連結來存取 API Explorer。
版本管理
建構應用程式時,API 穩定性是重要的考量因素。為協助您瞭解哪些端點日後可能會變更,哪些端點應維持穩定,我們將部分端點標示為 Beta 版。詳情請參閱「Looker API 版本控管」文件頁面。