Temos o prazer de anunciar que a API Looker 4.0 está disponível para todos os usuários no Looker 22.4. A API 4.0 de disponibilidade geral (API 4.0 GA) tem várias mudanças incompatíveis e aditivas e promove vários endpoints de Beta para Estável. Confira nossa referência da API para especificações detalhadas da API 4.0. Atualizamos os SDKs com suporte do Looker e da comunidade para oferecer suporte aos endpoints GA da API Looker 4.0. Para mais informações, consulte Políticas de suporte a APIs e SDKs e Controle de versões da API. O restante deste artigo descreve as mudanças interruptivas, as mitigações e os recursos que você pode esperar ao migrar para a API 4.0 GA.
Quem deve ler isso?
Este documento é para você se você usa a API Looker por SDKs compatíveis com o Looker, SDKs com suporte da comunidade ou a própria API. Leia a seção a seguir, que corresponde à versão da API Looker que você usa.
Usuários da API 4.0 pré-GA
Se você usa a API 4.0, leia esta seção. Ela aborda as mudanças interruptivas e as mitigações disponíveis ao migrar para a API 4.0 GA.
A GA da API 4.0 inclui a mudança de todos os campos de ID da entidade do tipo numérico integer
para o tipo string
. Por exemplo, o endpoint GET /groups/{group_id}
retorna id
como tipo string
em vez de int64
.
Leia a tabela a seguir para saber mais sobre o impacto e as mitigações específicas do uso do endpoint 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 aos usuários para atualizar 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 Ruby (API 4.0) | Sem impacto | Nenhuma ação é necessária |
SDKs com suporte da comunidade2 | ||
SDK do Swift | Exceções de execução | Atualize o SDK para a v22.0 ou mais recente e resolva os erros de tipo resultantes, se houver. |
SDK do Kotlin | Sem impacto | Nenhuma ação é necessária |
SDK do LookR | Sem impacto | Nenhuma ação é necessária |
SDK C# | Sem impacto | Nenhuma ação é necessária |
Go SDK | Exceções de execução | Atualize o SDK para a v22.0 ou mais recente e resolva os erros de tipo resultantes, se houver. |
Outro | ||
Como usar a API 4.0 sem um SDK (ou com bibliotecas fornecidas externamente) | Possíveis erros de tempo de execução, dependendo da sensibilidade ao tipo da linguagem | Revise o código para dependências no tipo de campos de ID e adicione suporte para campos de ID do tipo string. Consulte também estas orientações adicionais. |
1: considerando 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 aplicar operações numéricas a IDs.
2: Suporte à API e ao SDK do 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 aborda os recursos e mudanças adicionais que a API 4.0 disponibiliza para você. Todos os SDKs compatíveis com o Looker e com a comunidade são compatíveis principalmente com a API 4.0. Consulte Políticas de suporte a SDKs e APIs para mais informações.
Outros recursos GA da API 4.0
Para sua conveniência, listamos as mudanças mais notáveis e úteis da API 4.0:
- Criação e gerenciamento de quadros, itens e seções de quadros. Consulte a página de documentação do quadro para mais informações.
- Consulte outras informações de conexão, como bancos de dados, esquemas, colunas e tabelas. Defina e atualize outros campos de conexão.
- 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.
- Receba e defina as configurações da instância do Looker. Consulte a página de documentação de configurações para mais informações.
- Criação e gerenciamento de alertas. Consulte a página de documentação de alertas para mais informações.
- Criação, gerenciamento e teste de túneis e servidores SSH. Consulte a página de documentação do SSH para mais informações sobre o SSH.
- Mover e copiar painéis.
- Receber URLs relativos para novos painéis.
- Mover e copiar Looks.
- Incorporação assinada e chave secreta, URL, criação e gerenciamento de usuários de incorporação não assinada.
- Receber token de atualização para atualizar o token de acesso de login.
- Limite e ajuste os resultados para não receber todos os modelos do LookML e todos os usuários.
- Limite e ajuste os resultados da pesquisa de usuários.
- Extraia a especificação da API da instância do Looker em JSON do Swagger 2.x.
Mudanças na descontinuação da API 4.0 GA
A API 4.0 GA substitui vários endpoints da API 3.1 descontinuados por recursos aprimorados. Os seguintes endpoints são afetados:
- Os endpoints descontinuados da página inicial foram removidos. Use os endpoints do quadro em vez das páginas iniciais. Consulte Apresentação de conteúdo com quadros.
- Os endpoints descontinuados do espaço foram removidos. Use endpoints de pastas em vez de espaços. Consulte Organizar e gerenciar o acesso ao conteúdo.
Usuários da API 3.0
A API 3.0 está descontinuada. Recomendamos que você migre para a API 4.0.
- Somente a API 4.0 oferece suporte a todos os SDKs compatíveis com o Looker e a comunidade para facilitar o desenvolvimento. Confira nosso repositório de SDKs.
- A API 4.0 apresenta vários novos recursos e melhorias, conforme listado na seção Outros recursos GA da API 4.0 nesta página.
Conclusão
Aguarde novos recursos e mudanças incrementais que serão adicionados à API 4.0. Você sempre pode encontrar as mudanças mais recentes na nossa referência da API. Para mais informações, consulte Políticas de suporte a APIs e SDKs e Controle de versões da API. Sabemos que mudanças incompatíveis não são ideais. A menos que surja um problema extremo, não faremos mudanças interruptivas na nossa API 4.0 disponível para todos os usuários. Esperamos que a API Looker 4.0, que está disponível para todos, ajude você a desenvolver de maneira mais produtiva e fácil na plataforma Looker.