Looker API は、Looker インスタンスを管理し、Looker データ プラットフォームを介してデータを取得するための、安全な「RESTful」アプリケーション プログラミング インターフェースです。Looker API では、アプリケーションや自動化スクリプトを記述して、新しい Looker ユーザー アカウントのプロビジョニング、クエリの実行、レポートのスケジュール設定などを行うことができます。Looker API を介して実行できる機能は、Looker API についてほぼすべてです。
Looker API のパスとポート
Looker の API には、API URL を介してアクセスします。
Looker 管理者は [Admin > API] ページの [API Host URL] フィールドに、次のいずれかの形式で入力することで API パスを指定できます。
https://<instance_name>.api.looker.com
または
https://<instance_name>.api.<my_region>.looker.com
または
https://<instance_name>.looker.com
Looker 管理者は [API Host URL] フィールドを使用して、Looker サーバーのマシン名とは異なる API パスを割り当てることもできます。Looker がロードバランサの背後などにある場合によく発生します。その場合は、Looker 管理者に連絡して API パスを入手してください。
Looker 管理者が [API Host URL] フィールドを指定していない場合は、デフォルトの API パスが使用されます。Google Cloud、Microsoft Azure でホストされている Looker インスタンス、Amazon Web Service（AWS）でホストされているインスタンス（2020 年 7 月 7 日以降に作成されたもの）の場合、デフォルトの Looker API パスではポート 443 が使用されます。2020 年 7 月 7 日より前に作成された AWS でホストされている Looker インスタンスの場合、デフォルトの Looker API パスではポート 19999 が使用されます。デフォルトの API URL は次の形式になります。
https://<instance_name>.looker.com:<port>
上記の API URL は、デフォルトの API バージョン 3.1 に接続します。また、非推奨の API バージョン 3.0 を URL に
https://<instance_name>.looker.com:<port>/api/3.0/userまたはhttps://<instance_name>.api.looker.com/api/3.0/userの形式で指定して接続することもできます。
クライアント 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 Explorer がインストールされている Looker インスタンスへのアクセス権がない場合は、Looker のデベロッパー ポータルで公開バージョンを表示できます。
バージョニング
API の安定性は、アプリケーションを構築する際の重要な考慮事項です。将来変更される可能性があるエンドポイントと、安定していなければならないエンドポイントを理解できるように、特定のエンドポイントはベータ版としてマークされています。詳細については、Looker API バージョニングのドキュメントをご覧ください。