Introdução à API Looker

A API Looker é uma interface de programação de aplicativos "RESTful" segura para gerenciar sua instância do Looker e buscar dados pela plataforma de dados do Looker. Com a API Looker, é possível criar 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 pode ser feito pela API Looker.

Caminho e porta da API Looker

Acesse a API da sua instância do Looker pelo URL dela.

O administrador do Looker pode especificar um caminho de API inserindo-o no campo URL do host da API na página Admin > 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 de API padrão. Para instâncias do Looker hospedadas no Google Cloud, no Microsoft Azure e instâncias hospedadas na Amazon Web Service (AWS) criadas a partir de 07/07/2020, o caminho da API Looker padrão usa a porta 443. Para instâncias do Looker hospedadas na AWS criadas antes de 07/07/2020, o caminho da API Looker padrão usa a porta 19999. O URL da API padrão 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. Você pode criar solicitações HTTPS da API Looker manualmente usando curl (ou equivalente), usando o SDK Ruby do Looker ou gerando uma biblioteca de SDK do cliente para a linguagem de sua escolha. Recomendamos o uso de um SDK porque ele cuida dos detalhes de autenticação e solicitações HTTPS para você, para que você possa chamar a API Looker usando chamadas de função simples.

Confira os detalhes do SDK na página de documentação dos 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 isso dependem do uso ou não de um SDK. Instruções detalhadas podem ser encontradas na página de documentação de autenticação da API Looker.

Documentação interativa da API

Para a documentação de referência da API, a extensão API Explorer está disponível no Marketplace do Looker. 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 API do administrador 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 alterados no futuro e quais devem permanecer estáveis, marcamos alguns endpoints como beta. Para mais detalhes, consulte a página de documentação de controle de versões da API Looker .