Começar a usar a API Looker

A API Looker é uma interface de programação de aplicativo "RESTful" e segura para gerenciar sua instância do Looker e buscar dados pela plataforma de dados do Looker. Com a API Looker, você pode criar aplicativos ou scripts de automação para provisionar novas contas de usuário do Looker, executar consultas, programar relatórios etc. Praticamente tudo o que você pode fazer no aplicativo Looker usando a API Looker.

Caminho e porta da API Looker

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

O administrador do Looker pode especificar um caminho de API digitando-o no campo URL do host da API da 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 sua 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 vai usar o caminho da API padrão. Para instâncias do Looker hospedadas no Google Cloud, no Microsoft Azure e na 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 e criadas antes de 07/07/2020, o caminho padrão da API Looker usa a porta 19999. O URL padrão da API tem este formato:

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

SDKs do cliente

Você pode 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) com o SDK do Looker para Ruby ou gerando uma biblioteca de SDKs de cliente para a linguagem que preferir. Recomendamos usar 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.

Você vai encontrar detalhes do SDK na página de documentação dos SDKs da API Looker.

Authentication

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 protegido em trânsito.

As etapas para fazer isso dependem do uso de um SDK. Confira instruções detalhadas na página de documentação Autenticação da API Looker.

Documentação da API interativa

Para a documentação de referência da API, a extensão da 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ê é um administrador do Looker, também pode acessar o API Explorer clicando no link Usar a API Explorer na página Administrador da API do Looker.

Controle de versões

É importante considerar a estabilidade da API na 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 do controle de versões da API Looker.