O DataService Studio permite criar, publicar e governar APIs de dados sem desenvolver um serviço de backend. Conecte-se a uma fonte de dados, configure a lógica de consulta e exponha o resultado como uma API REST acionável, tudo dentro do DataWorks.
Use o gerenciamento de API para oferecer acesso controlado e sob demanda a conjuntos de dados específicos para aplicações ou equipes downstream. Para transferências de dados em massa ou exportações em grande escala, utilize soluções de sincronização de dados.
Público-alvo desta seção
O gerenciamento de API abrange dois fluxos de trabalho distintos, conforme sua função:
Publicadores de API — engenheiros ou analistas de dados que criam APIs baseadas em fontes de dados, testam e publicam essas APIs, além de controlar quem pode invocá-las.
Consumidores de API — desenvolvedores de aplicações ou consumidores de dados que descobrem APIs publicadas, solicitam autorização e integram essas APIs em suas aplicações.
Publicar uma API
Siga estas etapas para crie e publicar uma API de dados:
Crie uma API. Gere uma API a partir de uma source de dados usando a interface visual (sem SQL) ou o editor de código (para consultas SQL personalizadas). Alternativamente, registre um serviço HTTP/HTTPS externo existente para gerenciá-lo centralmente no DataService Studio.
Teste a API. Execute chamadas de teste na API antes da publicação para verifique a lógica de consulta, o tratamento de parâmetros e o formato de resposta.
Publique a API. Publique a API para torná-la acionável. Gerencie versões para reverter para uma versão anterior, se necessário.
Autorize os chamadores. Conceda permissão a aplicações ou usuários específicos para invocar a API publicada.
Invocar uma API
Siga estas etapas para integrar uma API publicada à sua aplicação:
Descubra a API. Navegue pelas APIs disponíveis no catálogo de serviços do DataService Studio e identifique aquela que atende à sua necessidade de dados.
Solicite autorização. Entre em contato com o publicador da API para obter permissão de chamada para sua aplicação.
Invoque a API. Use as credenciais de autorização para enviar solicitações ao endpoint da API a partir da sua aplicação.
Funcionalidades disponíveis
|
Tarefa |
Descrição |
|
Gerar APIs a partir de uma source de dados |
Crie uma API REST baseada em uma tabela de banco de dados ou consulta SQL, usando a interface visual ou o editor de código |
|
Registrar um serviço de API externo |
Importe uma API HTTP/HTTPS existente para o DataService Studio para publicação e governança centralizadas |
|
Testar, publicar e gerenciar versões |
Execute chamadas de teste, publique para tornar a API acionável e gerencie versões para permitir reversões |
|
Autorizar uma API |
Conceda permissão a aplicações específicas para invocar uma API publicada |
|
Invocar uma API |
Envie solicitações autenticadas para um endpoint de API publicado |
|
Configurar filtros de API |
Aplique pré-filtros e pós-filtros usando funções Aviator ou Python para pré-processar parâmetros de solicitação ou transformar respostas da API |
|
Gerenciar e manter APIs |
Monitore logs de chamadas, atualize a configuração da API, coloque uma API offline e organize APIs com rótulos |