Esta é a documentação do Looker. Para acessar a documentação do Looker Studio, acesse https://support.google.com/looker-studio.

Esta página foi traduzida pela API Cloud Translation.

Autenticação da API Looker usando OAuth

O Looker usa o OAuth para permitir que aplicativos clientes OAuth sejam autenticados na API Looker sem expor IDs e chaves secretas do cliente ao navegador que está executando o aplicativo cliente OAuth.

Os aplicativos da Web que usam OAuth precisam atender aos seguintes requisitos:

A autenticação usando OAuth está disponível apenas na API Looker 4.0.
Os aplicativos cliente OAuth precisam ser registrados no Looker usando a API antes que os usuários do aplicativo possam fazer a autenticação no Looker.
Os aplicativos clientes precisam usar HTTPS em todas as solicitações para a API Looker. Os aplicativos clientes que quiserem usar as APIs SubtleCrypto fornecidas pelo navegador precisam ser hospedados em HTTPS.

Suporte ao CORS da API Looker

É possível fazer chamadas na API Looker no navegador e entre origens usando o protocolo de Compartilhamento de recursos entre origens (CORS). O suporte ao CORS do Looker tem os seguintes requisitos:

Somente as origens listadas na lista de permissões de domínios incorporados podem chamar a API usando CORS.
Somente tokens de acesso recebidos do OAuth ou ao chamar o endpoint de API /login podem ser usados para fazer chamadas para a API Looker usando CORS.

Não é possível chamar o endpoint de API /login usando solicitações CORS. Os aplicativos clientes que querem chamar a API Looker usando solicitações CORS precisam usar o processo de login OAuth descrito em Fazer login do usuário com OAuth ou recuperar um token do servidor de aplicativos ou de chamadas de API que não sejam do CORS.

Visão geral da autenticação OAuth

Uma visão geral do processo de autenticação OAuth é a seguinte:

Registre o aplicativo cliente OAuth com a API Looker.
Adicione a origem do aplicativo cliente OAuth à lista de permissões de domínios incorporados para a chamada da API Code Exchange e todas as chamadas subsequentes da API CORS.
Redirecione o URL do navegador para o endpoint /auth no nome do host da interface do Looker (não o nome do host da API Looker) quando o aplicativo cliente OAuth tentar autenticar um usuário. Por exemplo, https://instance_name.looker.com.
Se o usuário for autenticado e conectado ao Looker, o Looker retornará um redirecionamento OAuth para o aplicativo cliente OAuth imediatamente. Se o usuário ainda não tiver feito login no Looker no dispositivo e no navegador, a tela de login vai aparecer e o usuário vai precisar fazer login na conta de usuário do Looker usando o protocolo de autenticação normal.
Usando o código de autorização retornado no redirecionamento do OAuth, seu aplicativo cliente OAuth precisa fazer uma chamada para o endpoint /token no nome do host da API Looker, por exemplo, https://instance_name.looker.com:19999. O nome do host da API pode ser igual ou diferente do nome do host da interface do Looker. O endpoint /token existe apenas no host da API Looker, e o endpoint /auth existe apenas no host da interface do Looker.
Se o código de autorização transmitido ao endpoint /token for válido, o Looker vai retornar uma API access_token ativada para solicitações da API CORS do domínio do aplicativo cliente OAuth.

Como registrar um aplicativo cliente OAuth

Todo aplicativo cliente OAuth que tentar se autenticar na API Looker usando OAuth precisa primeiro ser registrado na instância do Looker antes de autorizar o acesso. Para registrar um aplicativo cliente OAuth:

Abra o API Explorer na sua instância do Looker.
No menu suspenso de versão, escolha a versão 4.0 - estável da API.
No método Auth, encontre o endpoint de API register_oauth_client_app(). Também é possível pesquisar "OAuth app" no campo Pesquisa. Você pode usar register_oauth_client_app() para registrar seu aplicativo cliente OAuth no Looker. Clique no botão Run It, insira os parâmetros no APIs Explorer e clique em Run It novamente para registrar o aplicativo cliente OAuth ou use o endpoint de API register_oauth_client_app() de maneira programática. Os parâmetros register_oauth_client_app() obrigatórios são:
- client_guid: um ID globalmente exclusivo para o aplicativo
- redirect_uri: o URI em que o aplicativo receberá um redirecionamento OAuth que inclui um código de autorização.
- display_name: o nome do aplicativo que é exibido aos usuários do aplicativo
- description: uma descrição do aplicativo que é exibida aos usuários em uma página de divulgação e confirmação quando um usuário faz login no aplicativo pela primeira vez.
Os valores nos parâmetros client_guid e redirect_uri precisam corresponder exatamente aos valores fornecidos pelo aplicativo cliente OAuth. Caso contrário, a autenticação será negada.

Como fazer o login de usuário usando o OAuth

Navegue até o endpoint do /auth no host da UI. Exemplo:

async function oauth_login() {
  const code_verifier = secure_random(32)
  const code_challenge = await sha256_hash(code_verifier)
  const params = {
    response_type: 'code',
    client_id: '123456',
    redirect_uri: 'https://mywebapp.com:3000/authenticated',
    scope: 'cors_api',
    state: '1235813',
    code_challenge_method: 'S256',
    code_challenge: code_challenge,
  }
  const url = `${base_url}?${new URLSearchParams(params).toString()}` // Replace base_url with your full Looker instance's UI host URL, plus the `/auth` endpoint.
  log(url)

  // Stash the code verifier we created in sessionStorage, which
  // will survive page loads caused by login redirects
  // The code verifier value is needed after the login redirect
  // to redeem the auth_code received for an access_token
  //
  sessionStorage.setItem('code_verifier', code_verifier)

  document.location = url
}

function array_to_hex(array) {
  return Array.from(array).map(b => b.toString(16).padStart(2,'0')).join('')
}

function secure_random(byte_count) {
  const array = new Uint8Array(byte_count);
  crypto.getRandomValues(array);
  return array_to_hex(array)
}

async function sha256_hash(message) {
  const msgUint8 = new TextEncoder().encode(message)
  const hashBuffer = await crypto.subtle.digest('SHA-256', msgUint8)
  return base64.urlEncode(hashBuffer))  // Refers to the implementation of base64.encode stored at https://gist.github.com/jhurliman/1250118
}

O Looker vai tentar autenticar o usuário usando o sistema de autenticação que tem a instância configurada.

Se o usuário já tiver feito login no Looker no navegador atual (o que significa que se há um cookie de login ativo), ele não vai precisar inserir as credenciais de login.
Se esta for a primeira vez que o usuário faz login usando o aplicativo cliente OAuth, o Looker mostra uma declaração e uma página de confirmação para o usuário confirmar e aceitar. O texto do parâmetro description usado quando o aplicativo foi registrado será exibido. A descrição precisa indicar o que o aplicativo pretende fazer com a conta do Looker do usuário. Quando o usuário clicar em aceitar, a página será redirecionada para o aplicativo redirect_uri.
Se o usuário já tiver feito login no Looker no navegador atual e tiver confirmado a página de divulgação, o login do OAuth será instantâneo, sem interrupção visual.

A API Looker vai retornar um redirecionamento OAuth para o aplicativo cliente OAuth. Salve o código de autorização listado no parâmetro do URI. Este é um exemplo de URI de redirecionamento do OAuth:
```
https://mywebapp.com:3000/authenticated?&code=asdfasdfassdf&state=...
```
O código de autorização aparece depois de &code= no URI. Neste exemplo, o código de autorização é asdfasdfassdf.

Faça uma solicitação da Web para o endpoint /token na API Looker, transmitindo o código de autorização e as informações do aplicativo. Exemplo:

async function redeem_auth_code(response_str) {
  const params = new URLSearchParams(response_str)
  const auth_code = params.get('code')

  if (!auth_code) {
    log('ERROR: No authorization code in response')
    return
  }
  log(`auth code received: ${auth_code}`)
  log(`state: ${params.get('state')}`)

  const code_verifier = sessionStorage.getItem('code_verifier')
  if (!code_verifier) {
    log('ERROR: Missing code_verifier in session storage')
    return
  }
  sessionStorage.removeItem('code_verifier')
  const response = await
  fetch('https://mycompany.looker.com:19999/api/token', {  // This is the URL of your Looker instance's API web service
    method: 'POST',
    mode: 'cors',    // This line is required so that the browser will attempt a CORS request.
    body: stringify({
      grant_type: 'authorization_code',
      client_id: '123456',
      redirect_uri: 'https://mywebapp.com:3000/authenticated',
      code: auth_code,
      code_verifier: code_verifier,
    }),
    headers: {
      'x-looker-appid': 'Web App Auth & CORS API Demo', // This header is optional.
      'Content-Type': 'application/json;charset=UTF-8'  // This header is required.
    },
  }).catch((error) => {
    log(`Error: ${error.message}`)
  })

  const info = await response.json()
  log(`/api/token response: ${stringify(info)}`)

  // Store the access_token and other info,
  // which in this example is done in sessionStorage

  const expires_at = new Date(Date.now() + (info.expires_in * 1000))
  info.expires_at = expires_at
  log(`Access token expires at ${expires_at.toLocaleTimeString()} local time.`)
  sessionStorage.setItem('access_info', stringify(info))
  access_info = info
}

Uma resposta bem-sucedida fornecerá ao aplicativo cliente OAuth uma API access_token. A resposta também vai conter um refresh_token, que pode ser usado depois para receber um novo access_token sem interação do usuário. O refresh_token tem 1 mês de vida útil. Armazene o refresh_token com segurança.

Todos os tokens neste sistema podem ser revogados pelo administrador do Looker a qualquer momento.