Introdução à API Looker

A API Looker é uma interface de programação de aplicativos segura e "RESTful" para gerenciar sua instância do Looker e buscar dados pela plataforma de dados do Looker. Com a API Looker, é possível escrever aplicativos ou scripts de automação para provisionar novas contas de usuário do Looker, executar consultas, programar entregas de dados etc. Quase tudo o que você pode fazer no aplicativo Looker também pode ser feito pela API Looker.

Caminho e porta da API Looker

Acesse a API da sua instância do Looker usando o URL da API.

O administrador do Looker pode especificar um caminho de API inserindo-o no campo URL do host da API na página Administrador > API no seguinte formato:

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

O administrador do Looker também pode usar o campo URL do host da API para atribuir um caminho de API diferente do nome da máquina do servidor do Looker. Isso é comum quando a instalação do Looker está atrás de um balanceador de carga, por exemplo. Nesse caso, entre em contato com o administrador do Looker para saber o caminho da API.

Se o administrador do Looker não tiver especificado o campo URL do host da API, o Looker usará o caminho padrão da API. Para instâncias do Looker hospedadas no Google Cloud, no Microsoft Azure e na Amazon Web Service (AWS) criadas a partir de 07/07/2020, o caminho padrão da API Looker usa a porta 443. Para instâncias do Looker hospedadas na AWS e criadas antes de 07/07/2020, o caminho padrão da API Looker usa a porta 19999. O URL padrão da API está no seguinte formato:

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

SDKs do cliente

É possível usar a API Looker com qualquer linguagem de programação ou ambiente de aplicativo que possa fazer solicitações HTTPS e processar respostas JSON. É possível criar solicitações HTTPS da API Looker manualmente usando curl (ou equivalente), o SDK Ruby do Looker ou gerando uma biblioteca de SDK do cliente para a linguagem de programação escolhida. Recomendamos usar um SDK porque ele cuida dos detalhes de autenticação e das solicitações HTTPS para você, permitindo que você chame a API Looker usando chamadas de função simples.

Confira os detalhes do SDK na página de documentação SDKs da API Looker.

Autenticação

O Looker autentica solicitações de API usando um token de acesso do portador OAuth 2.0 no cabeçalho de autorização HTTP da solicitação. Todos os endpoints da API Looker exigem uma conexão HTTPS segura para que o token de acesso fique seguro em trânsito.

As etapas para fazer isso dependem de você estar usando um SDK ou não. Confira instruções detalhadas na página de documentação Autenticação da API Looker.

Documentação interativa da API

Para a documentação de referência da API, a extensão do API Explorer está disponível no Looker Marketplace. Para mais informações, consulte a página de documentação Como usar o API Explorer. Se você for um administrador do Looker, também poderá acessar o API Explorer clicando no link Usar o API Explorer na página de administração da API do Looker.

Controle de versões

A estabilidade da API é uma consideração importante ao criar aplicativos. Para ajudar você a entender quais endpoints podem ser mudados no futuro e quais devem permanecer estáveis, marcamos alguns deles como estando na versão Beta. Para mais detalhes, consulte a página de documentação Controle de versões da API Looker.