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 escrever aplicativos ou scripts de automação para provisionar novas contas de usuário do Looker, executar consultas, agendar entregas de dados etc. Praticamente tudo o que você pode fazer no aplicativo Looker, podendo usar a API Looker.

Caminho e porta da API Looker

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

O administrador do Looker pode especificar um caminho de API inserindo-o no campo URL do host da API em 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á por trá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 vai usar o caminho da API padrão. Para instâncias do Looker hospedadas no Google Cloud, Microsoft Azure e instâncias hospedadas no Amazon Web Service (AWS) que foram 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 que foram criadas antes de 07/07/2020, o caminho padrão da API Looker usa a porta 19999. O URL padrão da API tem o 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 capaz de fazer solicitações HTTPS e processar respostas JSON. É possível criar solicitações HTTPS da API Looker manualmente usando curl (ou equivalente), usando o SDK do Looker para Ruby ou gerando uma biblioteca de SDK cliente para a linguagem que você preferir. Recomendamos o uso de um SDK, porque ele cuida dos detalhes da autenticação e das solicitações HTTPS para que você possa chamar a API Looker usando chamadas de função simples.

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

Autenticação

O Looker autentica as 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 permaneça seguro em trânsito.

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

Documentação interativa da API

Para 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 APIs Explorer. Os administradores do Looker também podem acessar o APIs Explorer clicando no link Usar APIs Explorer na página Administrador da API.

Controle de versões

A estabilidade da API é importante para a criação de 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 Versionamento da API Looker.