Primeiros passos com a API Looker

A API Looker é uma interface de programação de aplicativos segura para o gerenciamento de instâncias do Looker e a busca de dados pela plataforma de dados do Looker. Com a API Looker, você pode gravar aplicativos ou scripts de automação para provisionar novas contas de usuário do Looker, executar consultas, programar relatórios etc. É possível fazer tudo o que você pode fazer no aplicativo Looker pela API Looker.

Caminho e porta da API Looker

Acesse a API da instância do Looker por meio do 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 Admin > API em um dos seguintes formatos:

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

ou

https://<instance_name>.api.<my_region>.looker.com

ou

https://<instance_name>.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 do computador do servidor 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.

Caso o administrador do Looker não tenha especificado o campo URL do host da API, o Looker usará o caminho da API padrão. Para instâncias do Looker hospedadas no Google Cloud, Microsoft Azure e instâncias hospedadas 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 que foram criadas antes de 07/07/2020, o caminho padrão da API do Looker usa a porta 19999. O URL da API padrão tem este formato:

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

Os URLs de API acima se conectam à versão padrão da API 3.1. Também é possível se conectar à API 3.0 que foi descontinuada. Basta especificar o URL no formato https://<instance_name>.looker.com:<port>/api/3.0/user ou https://<instance_name>.api.looker.com/api/3.0/user.

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), usando o SDK Ruby do Looker ou gerando uma biblioteca de SDK do cliente para sua linguagem preferida. Recomendamos o uso de um SDK porque ele cuida dos detalhes da autenticação e das solicitações HTTPS para você. Assim, é possível chamar a API Looker usando chamadas de função simples.

Os detalhes do SDK estão disponíveis na nossa 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 seja protegido em trânsito.

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

Documentação da API Interactive

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

Se você não tiver acesso a uma instância do Looker em que o APIs Explorer está instalado, veja uma versão pública no Portal do desenvolvedor do Looker.

Controle de versões

A estabilidade da API é uma consideração importante ao criar aplicativos. Para que você possa entender quais endpoints podem ser alterados no futuro e quais precisam permanecer estáveis, marcamos alguns endpoints como Beta. Para ver mais detalhes, consulte a página de documentação Controle de versão da API Looker.