Looker API は Looker インスタンスを管理するための安全で「RESTful」なアプリケーションプログラミングインターフェースで、Looker データプラットフォームを通じてデータをフェッチします。Looker API では、新しい Looker ユーザー アカウントのプロビジョニング、クエリの実行、レポートのスケジュール設定などを行うアプリケーションまたは自動化スクリプトを記述できます。Looker API を介して Looker アプリケーションで実行できることがすべて実行可能です。
Looker API のパスとポート
Looker インスタンスの API に、API の URL を介してアクセスします。
Looker 管理者は、[Admin] > [API] ページの [API Host URL] フィールドに次のいずれかの形式で入力することで、API パスを指定できます。
https://<instance_name>.cloud.looker.com
Looker 管理者は、API ホスト URL フィールドを使用して、Looker サーバーマシン名とは異なる API パスを割り当てることもできます。これは、たとえば Looker のインストールがロードバランサの背後にある場合に頻繁に発生します。この場合、API パスについて Looker 管理者にお問い合わせください。
Looker 管理者が [API Host URL] フィールドを指定しない場合、Looker はデフォルトの API パスを使用します。2020 年 7 月 7 日以降に作成された Google Cloud、Microsoft Azure でホストされている Amazon インスタンス、および Amazon Web Service（AWS）でホストされているインスタンスの場合、デフォルトの Looker API パスはポート 443 を使用します。2020 年 7 月 7 日より前に作成された AWS でホストされている Looker インスタンスの場合、デフォルトの Looker API パスはポート 19999 を使用します。デフォルトの API URL は、次の形式です。
https://<instance_name>.cloud.looker.com:<port>
上記の API URL はデフォルトの API バージョン 4.0 に接続します。非推奨の API バージョン 3.1 には、
https://<instance_name>.cloud.looker.com:<port>/api/3.1/userの形式により URL で指定することでも接続できます。
クライアント SDK
Looker API は、HTTPS リクエストを作成して JSON レスポンスを処理できる任意のプログラミング言語やアプリケーション環境で使用できます。Looker API の HTTPS リクエストは、curl （または同等のもの）を使用するか、Looker Ruby SDK を使用するか、選択した言語のクライアント SDK ライブラリを生成することで、手動で作成できます。SDK の使用をおすすめします。SDK は認証と HTTPS リクエストの詳細を処理するため、単純な関数呼び出しを使用して Looker API を呼び出すことができます。
SDK の詳細については、Looker API SDK のドキュメント ページをご覧ください。
Authentication
Looker は、リクエストの HTTP 認可ヘッダーで OAuth 2.0 署名なしアクセス トークンを使用して API リクエストを認証します。すべての Looker API エンドポイントでは、アクセス トークンが転送時に保護されるように、安全な HTTPS 接続が必要です。
これを実現する手順は、SDK を使用しているかどうかによって異なります。詳細な手順については、Looker API の認証ドキュメント ページをご覧ください。
インタラクティブな API ドキュメント
API リファレンス ドキュメントでは、API Explorer 拡張機能を Looker Marketplace から入手できます。詳細については、API Explorer の使用のドキュメントをご覧ください。Looker 管理者は、Looker の API 管理ページにある [Use API Explorer] をクリックして API Explorer にアクセスすることもできます。
API Explorer がインストールされている Looker インスタンスへのアクセス権がない場合は、Looker のデベロッパー ポータルで公開バージョンを表示できます。
バージョニング
API の安定性は、アプリケーションの構築時に重要な考慮事項です。将来どのエンドポイントが変更されるか、そしてどのエンドポイントが安定しているのかを把握できるように、特定のエンドポイントはベータ版としてマークされています。詳細については、Looker API のバージョニングのドキュメントをご覧ください。