Gaio Documentation
Portuguese
Portuguese
  • Bem vindo à documentação da Plataforma Gaio!
  • Documentação
    • Informações Gerais
      • Estrutura de Funcionamento
      • Login
      • Página Inicial
    • Aplicações
    • Studio
      • Processos
      • Fontes de Dados
      • Tarefas
        • ETL
          • Consulta
          • SQL
          • SQL Externo
          • Inserção Tabela
          • Inserção Linha
          • Atualização
          • Exclusão
          • Cria Tabela
          • Quick Table
          • Pivot Table
          • Unpivot Table
          • Executar Processo
          • Rest
          • Parâmetros para Tabela
          • Tabela para Parâmetros
          • Usuários
          • CSV Web
          • Google Planilhas
        • Analytics
          • Amostragem
          • AutoML
          • Scoring
          • Cluster
          • Componentes Principais
          • Regras de Associação
          • Séries Temporais
          • Python
        • Delivery
          • Relatório
          • Power Search
          • Conteúdo
          • Formulário
          • Exportar Output
          • Banner
          • Exportar CSV
          • Mapa
          • Insights
          • API
          • SMS
          • WhatsApp
          • Email
          • Network
      • Parâmetros
      • Formulários
      • Arquivos
      • Botões de Ação
      • Menu Superior
        • SQL
        • Editar Tabelas do Bucket
        • Execuções em Andamento
        • Editor de Mapas
        • Agendamento
        • Modelos
        • Cognitivo
        • Log de erros
        • Editar Dashboard
        • Chat - GPS
        • Menu Geral
    • Administração
      • Permissões
      • Usuários
      • Fontes de Dados
      • Repositórios
        • Criação
        • Gestão de Dados
      • Compartilhamento
      • Agendamento
      • Log
    • Atalhos do Teclado
  • Integrações
    • LDAP
  • HUB
    • Exemplos
      • Tarefa Conteúdo
        • Formulário Manual
  • FAQ
  • Gestão de Servidor
    • Inicialização do Gaio
  • What's New!
    • Release Notes
      • 2022
Powered by GitBook
On this page
  • 5. Retorno
  • 6. Log de erros
  1. Documentação
  2. Studio
  3. Tarefas
  4. ETL

Rest

PreviousExecutar ProcessoNextParâmetros para Tabela

Last updated 2 years ago

Diferente da tarefa , essa tarefa ao invés de fornecer um Endpoint para outros sistemas usarem o Gaio, ele permite ao Gaio conectar em APIs externas.

Para utilizar, é necessário que o analista conheça bem como utilizar a API na qual o Gaio irá conectar. Os sistemas que fornecem conexão via API tem o padrão de fornecer uma documentação.

Uma tabela é necessária para usar a tarefa Rest. Ela irá fornecer por exemplo a coluna CPF que permitirá retornar dados de um sistema externo daqueles CPFs presentes na tabela de origem. Se nenhum dado for necessário ser enviado para a API, ainda assim, é necessário ter uma tabela de referência, que pode não fornecer dados. Contudo é importante que para cada linha da tabela, o Gaio irá fazer uma chamada no endpoint fornecido.

O Gaio interpreta somente JSON no retorno da API.

  1. Tipo de requisição: O Gaio permite conexões à endpoints usando GET ou POST.

  2. Endpoint: Informe o endpoint da API de destino. Nesse endereço é possível passar colunas da tabela de origem, como por exemplo https://www.receitaws.com.br/v1/cnpj/{{cnpj}}. Nesse caso, cnpj é uma coluna da tabela de origem. Seus valores serão passados para a API consultada e o retorno será gravado em uma tabela Gaio.

  3. Tempo máximo de requisição: se 0 é informado, o Gaio irá aguardar o retorno da API por tempo ilimitado. Nesse ponto o tempo é registrado em milissegundos (1000 = 1 segundo).

  4. Propriedades e Valores: Defina os cabeçalhos enviados durante a requisição de API. Ex: Bearer, Authorization, Accept dentre outros.

5. Retorno

Várias configurações podem ser ajustadas para trabalhar o retorno de dados da API.

  • Defina o nome da tabela que irá armazenar o retorno.

  • Escolha entre identificar as colunas de retorno automaticamente ou de forma manual.

    • Automática: A tarefa irá identificar o nome, quantidade e tipo (data type) das colunas dentro da lista ou do objeto de retorno da API. Caso deseje, informe ao Gaio a propriedade/endpoint em que se encontra os nome/tipos de dados. Se a resposta for um OBJETO JSON, será inserido uma linha nesta tabela, mas se a resposta for uma LISTA/ARRAY no JSON, será inserido uma linha por item desta lista.

    • Manual: É necessário definir os campos que serão capturados da resposta da API. Se a resposta for um OBJETO JSON, será inserido uma linha nesta tabela mas se a resposta for uma LISTA/ARRAY no JSON, será inserido uma linha por item desta lista.

  • Dados da tabela de origem: pode ser desejado levar alguns campos da tabela de origem para a tabela de destino, como por exemplo um código do cliente consultado.

  • Excluir tabela antes de inserir dados: é possível acumular os dados retornados na tabela de destino ou apagá-la sempre que o processo for executado. Dois campos serão adicionados à tabela criada: gaio_id que se refere a um valor numérico único e gaio_created_at que se refere à data-hora de inserção da linha na tabela

  • Propriedade do objeto em que se encontra os resultados: se o JSON retornado tiver um objeto tem hierarquia dentro dele, é possível retornar essa hierarquia e construir uma nova tabela, usando essa opção. A forma de chamar é por exemplo result.data.

6. Log de erros

Defina o nome da tabela de log, que sempre começará com log_ e desse ponto em diante pode ser personalizada pelo analista.

O primeiro passo é clicar na tabela, ir no menu e clicar em Rest.

Tarefas
API