Autenticação da API Looker

Para fazer qualquer coisa com a API Looker, tem de se autenticar primeiro. Os passos que tem de seguir dependem de estar ou não a usar um SDK.

Autenticação com um SDK

Este é o método recomendado para a autenticação da API:

  1. Crie credenciais da API na página Utilizadores na secção Administração da sua instância do Looker. Se não for administrador do Looker, peça ao administrador do Looker para criar as credenciais da API por si.

    As credenciais da API estão sempre associadas a uma conta de utilizador do Looker. Os pedidos de API são executados "como" o utilizador associado às credenciais da API. As chamadas para a API apenas devolvem dados que o utilizador tem autorização para ver e modificam apenas o que o utilizador tem autorização para modificar.

  2. As credenciais da API que gerou incluem um ID de cliente e um segredo do cliente. Tem de fornecê-los ao SDK. Pode encontrar as instruções para o fazer na documentação do SDK.

Em seguida, o SDK encarrega-se de obter os tokens de acesso necessários e de os inserir em todos os pedidos de API subsequentes.

Autenticação sem um SDK

A autenticação da API com um SDK é o método recomendado. Para autenticar sem um SDK:

  1. Crie credenciais da API na página Utilizadores na secção Administração da sua instância do Looker. Se não for administrador do Looker, peça ao administrador do Looker para criar as credenciais da API por si.

    As credenciais da API estão sempre associadas a uma conta de utilizador do Looker. Os pedidos de API são executados "como" o utilizador associado às credenciais da API. As chamadas para a API apenas devolvem dados que o utilizador tem autorização para ver e modificam apenas o que o utilizador tem autorização para modificar.

  2. Obtenha uma chave de acesso OAuth 2.0 de curto prazo chamando o ponto final login da API. Tem de fornecer as credenciais da API que gerou no passo 1, que incluem um ID de cliente e um segredo do cliente.

  3. Coloque esse token de acesso no cabeçalho de autorização HTTP dos pedidos da API Looker. Um exemplo de pedido da API Looker com um cabeçalho de autorização pode ter o seguinte aspeto:

    GET /api/4.0/user HTTP/1.1
    Host: test.looker.com
    Date: Wed, 19 Oct 2023 12:34:56 -0700
    Authorization: token mt6Xc8jJC9GfJzKBQ5SqFZTZRVX8KY6k49TMPS8F
    

A chave de acesso de OAuth 2.0 pode ser usada em vários pedidos da API até expirar ou ser invalidada através da chamada do ponto final logout. Os pedidos API que usam uma chave de acesso expirada falham com uma resposta HTTP 401 Authorization Required.

Interação da API com as definições de início de sessão do utilizador

A autenticação da API Looker é completamente independente do início de sessão do utilizador do Looker. Os protocolos de autenticação de utilizadores, como códigos de acesso únicos (PUU, 2FA) e autenticação de diretório (LDAP, SAML, etc.), não se aplicam à autenticação da API Looker.

Por este motivo, a eliminação das informações de um utilizador de um protocolo de autenticação de utilizadores não elimina as respetivas credenciais da API. A utilização dos procedimentos na página de documentação Eliminar informações pessoais do utilizador remove todos os dados pessoais de um utilizador do Looker, impedindo-o de iniciar sessão, inclusive através da API.

Gerir credenciais da API

  • É possível associar vários conjuntos de credenciais da API a uma única conta de utilizador do Looker.
  • As credenciais da API podem ser criadas e eliminadas sem afetar o estado da conta de utilizador.
  • A eliminação de uma conta de utilizador do Looker invalida todas as credenciais da API associadas à conta de utilizador.
  • O segredo do cliente da API tem de ser mantido privado. Evite armazenar segredos do cliente da API no código fonte ou noutros locais que possam ser vistos por muitas pessoas.
  • Em produção, evite usar credenciais da API associadas a contas de administrador do Looker. Crie contas de utilizador com privilégios mínimos especificamente para atividades da API (frequentemente denominadas "contas de serviço") e crie credenciais da API nessas contas. Conceda apenas as autorizações necessárias para as atividades de API pretendidas.

Autenticação HTTPS

Mesmo que esteja a usar um SDK do cliente para tratar dos detalhes de autenticação, pode ter curiosidade sobre como funciona a autenticação da API Looker. Para ver detalhes de baixo nível sobre a autenticação, consulte o artigo Como autenticar na API Looker no GitHub.

Autenticação com OAuth

O Looker pode usar o protocolo de partilha de recursos de origem cruzada (CORS) para permitir que as aplicações Web façam chamadas para a API Looker a partir de fora do domínio de uma instância do Looker. Consulte a página de documentação Autenticação da API Looker com OAuth para obter informações sobre a configuração da autenticação CORS.