A API Looker 4.0 está disponível para todos no Looker 22.4. A API 4.0 (API 4.0 GA), com disponibilidade geral, tem várias alterações interruptivas e aditivas e promove vários endpoints de Beta para Stable. Confira nossa referência da API para ver as especificações detalhadas da API 4.0. Atualizamos os SDKs com suporte do Looker e com a comunidade para oferecer suporte aos endpoints em disponibilidade geral da API Looker 4.0. Para mais informações, consulte Políticas de suporte de API e SDK e Controle de versões de API. O restante deste artigo descreve as alterações interruptivas, as mitigações e os recursos que você pode conferir ao migrar para a API 4.0 GA.
Quem deve ler isto?
Este documento é para quem usa a API Looker com SDKs com suporte ao Looker, SDKs com suporte da comunidade ou a própria API. Leia a seção a seguir que mapeia a versão da API Looker que você usa atualmente.
Usuários da API 4.0 pré-GA
Se você usa a API 4.0, leia esta seção. Abrange as alterações interruptivas e as mitigações disponíveis quando você migra para a API 4.0 em disponibilidade geral.
A API 4.0 GA inclui a alteração de todos os campos de ID da entidade do tipo integer numérico para o tipo string. Por exemplo, o endpoint GET /groups/{group_id} retorna id como o tipo string em vez do tipo int64.
Leia a tabela a seguir para conhecer o impacto e as mitigações específicas do uso de endpoints da API 4.0:
| Uso | Possível impacto1 | Prevenção |
| Apps Looker para dispositivos móveis | As instalações desatualizadas dos apps Looker para dispositivos móveis param de funcionar | Peça para os usuários atualizarem para a versão mais recente dos apps Looker para dispositivos móveis |
| SDKs compatíveis com o Looker2 | ||
| SDK do TypeScript (API 4.0) | Sem impacto | Nenhuma ação é necessária |
| SDK do Python (API 4.0) | Sem impacto | Nenhuma ação é necessária |
| SDK do Ruby (API 4.0) | Sem impacto | Nenhuma ação é necessária |
| SDKs suportados pela comunidade2 | ||
| SDK Swift | Exceções de tempo de execução | Atualize o SDK para a v22.0+ e resolva os erros de tipo resultantes, se houver |
| SDK do Kotlin | Sem impacto | Nenhuma ação é necessária |
| SDK do Looker | Sem impacto | Nenhuma ação é necessária |
| SDK do C# | Sem impacto | Nenhuma ação é necessária |
| Go SDK | Exceções de tempo de execução | Atualize o SDK para a v22.0+ e resolva os erros de tipo resultantes, se houver |
| Outros | ||
| Usar a API 4.0 sem um SDK (ou com bibliotecas fornecidas externamente) | Possíveis erros de tempo de execução, dependendo da sensibilidade de tipo da linguagem | Revise o código em busca de dependências no tipo de qualquer campo de ID e adicione suporte para campos de ID do tipo string. Leia também estas orientações adicionais. |
1: Supondo padrões de uso comuns que podem incluir o uso dos campos de ID do Looker, mas não padrões de uso incomuns, como a aplicação de operações numéricas a IDs.
2: Suporte ao SDK e à API Looker. As bibliotecas com suporte da comunidade não têm suporte oficial do Looker.
Usuários da API 3.1
Se você usa a API 3.1, leia esta seção. Ele abrange os recursos adicionais e as mudanças que a API 4.0 disponibiliza. Todos os nossos SDKs com suporte ao Looker e com suporte da comunidade têm suporte principalmente à API 4.0. Consulte as políticas de suporte a SDKs e APIs para mais informações.
Recursos adicionais da API 4.0 GA
Para facilitar, listamos as mais importantes e úteis alterações aditivas da API 4.0 para você:
- Criação e gerenciamento de seções, itens da diretoria e seções. Consulte a página de documentação da placa para mais informações sobre placas.
- Consulte outras informações de conexão, como bancos de dados, esquemas, colunas e tabelas. Defina e atualize campos de conexão adicionais.
- Criação e gerenciamento de usuários e apps OAuth. Consulte a página de documentação do OAuth para mais informações sobre o OAuth.
- Pesquise grupos com hierarquia e funções.
- Pesquisar funções com contagem de usuários.
- Obter e definir as configurações da instância do Looker. Consulte a página de documentação de configurações para mais informações sobre as configurações.
- Criação e gerenciamento de alertas. Consulte a página da documentação sobre alertas para mais informações.
- Criação, gerenciamento e teste de túneis SSH e servidores SSH. Consulte a página de documentação do SSH para mais informações.
- Mover e copiar painéis.
- Consiga URLs relativos para novos painéis.
- Mover e copiar Looks.
- Incorporação assinada e segredo de incorporação não assinado, URL e criação e gerenciamento de usuários.
- Receber o token de atualização para atualizar o token de acesso de login.
- Limite e desloque os resultados do recebimento de todos os modelos do LookML e todos os usuários.
- Limite e desloque os resultados da pesquisa de usuários.
- Confira a especificação da API da instância do Looker em JSON Swagger 2.x.
Alterações de descontinuação do GA na API 4.0
A API 4.0 GA substitui vários endpoints da API 3.1 descontinuados por recursos aprimorados. Listamos abaixo os endpoints afetados:
- Os endpoints descontinuados da página inicial foram removidos. Use endpoints da placa em vez de páginas iniciais. Consulte Apresentar conteúdo com quadros.
- Os endpoints do espaço descontinuados foram removidos. Use endpoints de pasta em vez da barra de espaço. Consulte Como organizar e gerenciar o acesso ao conteúdo.
Usuários da API 3.0
A API 3.0 foi descontinuada. Recomendamos que você migre para a API 4.0.
- Apenas a API 4.0 oferece suporte a todos os SDKs com suporte ao Looker e com suporte da comunidade para facilitar o desenvolvimento. Confira nosso repositório do SDK.
- A API 4.0 apresenta vários novos recursos e melhorias, conforme listado na seção Recursos adicionais da API 4.0 GA desta página.
Conclusão
Você pode esperar a adição de novos recursos e outras mudanças à API 4.0. Para conferir as mudanças mais recentes, acesse a Referência da API. Para mais informações, consulte Políticas de suporte de API e SDK e Controle de versões de API. Sabemos que alterações interruptivas não são ideais. A menos que surja um problema extremo, não faremos alterações interruptivas em nossa API 4.0, disponível ao público geral. Esperamos que a nossa API 4.0, que é disponibilizada de forma geral, ajude você a desenvolver apps de maneira mais produtiva e fácil na plataforma Looker.