A API Looker é uma interface de programação do aplicativo "RESTful" segura para gerenciar sua instância do Looker e buscar dados por meio da 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, executar consultas, programar relatórios etc. É possível realizar qualquer coisa no aplicativo Looker usando a API Looker.
Caminho e porta da API Looker
Acesse a API da sua instância do Looker pelo URL dela.
Seu 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
Seu 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 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 em 07/07/2020 ou após essa data, 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 da API padrão está no seguinte formato:
https://<instance_name>.cloud.looker.com:<port>
Os URLs da API acima se conectam à versão padrão da versão 4.0. Também é possível se conectar à API obsoleta 3.1 especificando-a no URL com o formato
https://<instance_name>.cloud.looker.com:<port>/api/3.1/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. 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 de 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 que você possa chamar a API Looker usando chamadas de função simples.
Veja detalhes sobre o SDK na página de documentação dos SDKs da Looker API.
Authentication
O Looker autentica solicitações de API usando um token de acesso ao 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 do uso ou não de um SDK. Instruções detalhadas podem ser encontradas na página da documentação de autenticação da API Looker.
Documentação da API interativa
Para documentação de referência da API, a extensão do API Explorer está disponível a partir do 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 API Explorer na página Administrador da API do Looker.
Se você não tiver acesso a uma instância do Looker em que a API Explorer esteja instalada, será possível visualizar 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 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 Controle de versões da API Looker.