Consumindo produtos de dados por meio de APIs
Ative os endpoints da API para consultar, filtrar e consumir seus dados em ferramentas e ecossistemas. Quando os endpoints estiverem ativos, você poderá acessar seus dados por meio de APIs compatíveis com o OData.
Ativando os endpoints da API
- No menu Produtos de dados, clique no produto de dados para o qual você deseja ativar os endpoints da API.
- Na guia Visão geral, clique em Editar > Endpoints da API.
A janela Editar produto de dados é aberta.
- Selecione os conjuntos de dados para os quais você deseja ativar os endpoints da API.
- Clique em Salvar.
Você está de volta à guia Visão geral, e a opção Endpoints da API está disponível no menu Ações, no canto superior direito.
Os endpoints da API são criados, e você pode configurá-los.
Quando o produto de dados é ativado no marketplace, os endpoints da API também são ativados na versão ativa do marketplace.
Configurando os endpoints da API
Depois de ativar os endpoints da API, você pode configurar a conexão que deve ser usada para consumir os conjuntos de dados.
Os endpoints baseados em arquivos são consumidos no mesmo armazenamento que o conjunto de dados.
- Na guia Visão geral, clique em
> Consumir em > Endpoints da API. A janela Endpoints da API é aberta.
- Se necessário, selecione outra conexão.
Suas alterações serão salvas automaticamente.
Usando as APIs
Quando os endpoints da API forem ativados, você poderá usar consultas para consumir seus dados em outras ferramentas.
O protocolo do OData é usado. Para obter mais informações, consulte a documentação da Microsoft.
O formato de uma consulta no Power Query ou no PowerBI é o seguinte:= OData.Feed("url-of-the-dataset", null, [Headers = [Authorization = "Bearer your-api-key"]])
Você precisa adaptar o seguinte ao seu uso:
url-of-the-dataset. Substitua essa parte pela URL da janela de endpoints da API.
your-api-key. Substitua essa parte por sua chave da API.
- Ative os endpoints da API. Veja o procedimento acima.
- Gere uma chave de API caso ainda não tenha uma. Para obter mais informações, consulte Gerando e gerenciando chaves de API.
- Abra a ferramenta de sua escolha para obter os dados. Neste exemplo, o PowerBI é usado.
- Clique em Obter dados > Consulta em branco.
- Digite a consulta.
Aqui está um exemplo de consulta que você pode adaptar e usar no Power Query ou no PowerBI para recuperar dados de um conjunto de dados.
= OData.Feed("https://qcs.us.qlikcloud.com/api/data-governance/data-access/data-products/687e50d58d4773120e843007/datasets/687e508ee636a966d6a6f9e4/connections/9d0d8a52-33a8-4d46-be28-068b4fd06282", null, [Headers = [Authorization = "Bearer your-api-key"]]) - Se você quiser recuperar dados de outros conjuntos de dados, crie uma consulta por conjunto de dados.
- Clique em Fechar e aplicar para aplicar suas consultas.
- Quando os dados forem importados, defina as relações entre as tabelas.
- Clique em Gerenciar relacionamentos > Novo relacionamento.
- Selecione as tabelas e salve.
- Crie quantos relacionamentos forem necessários.
Quando os relacionamentos estiverem configurados, você poderá visualizar seus dados em gráficos.