Academy
Fontes de Dados

Etapa API Rest

A etapa API Rest importa dados de uma API para iniciar um fluxo de dados. Uma API (Application Programming Interface) é um conjunto de regras e padrões que permite que diferentes sistemas se comuniquem entre si. Depois de configurar a etapa, você executa o fluxo e usa os dados retornados pela API. Ela fica na categoria Fonte de Dados da barra de ferramentas.

Aba API

Configure aqui os dados principais da conexão:

  • Nome: identifica a etapa. O campo é editável, defina o nome que preferir.

  • URL do endpoint: endereço de acesso à API.

  • Método: informe se a API é GET ou POST.

  • Possui paginação?: habilite quando a API for paginada. Ao habilitar, escolha o Tipo de Paginação.

Quando há paginação, o tipo pode ser:

  • Paginado pelo índice da página: as páginas são controladas pelo número da página (página 1, página 2 e assim por diante). Informe a variável {page} na URL onde entra o número da página. Exemplo: https://minhaapi.com.br/relatorio?empresa=1&data=2023-08-02&pagina={page}.

  • Paginado pelo índice da linha: as páginas são controladas pelo número de linhas. A requisição informa a linha inicial e o limite de linhas a retornar. Use a variável {offset} para a linha inicial e {limit} para o limite de registros. Exemplo: https://minhaapi.com.br/relatorio?empresa=1&data=2023-08-02&offset={offset}&limit={limit}.

Amostra de dados: a amostra gerada na etapa API Rest traz apenas a primeira página. A ideia é exibir alguns registros que ajudem a construir o fluxo.

O que são GET e POST

GET e POST são métodos HTTP que indicam a ação desejada em uma requisição. Toda requisição precisa informar um método. Existem outros (PUT, DELETE, entre outros), mas os dois usados para obter dados são GET e POST:

  • GET: usado quando o objetivo é obter dados.

  • POST: usado principalmente para enviar dados e, em alguns casos, também para obtê-los.

Método POST: ao selecionar POST, a plataforma habilita a aba Corpo para você preencher os dados a enviar na chamada.

Parâmetros de URL

Você pode informar parâmetros para serem substituídos na URL antes da conexão com a API. Há dois tipos:

  • Fixo: preenchido com um valor fixo, como o código da empresa ou a moeda desejada.

  • Data Ref.: envia a data de referência da execução do fluxo. Durante a edição do fluxo, vale a data de simulação (definida na barra da Amostra de Dados); durante a execução, vale a data de referência informada.

Suponha que você consulte os dados informando empresa e data na URL. Em vez da URL fixa https://minhaapi.com.br/relatorio?empresa=1&data=2023-08-02, configure o endpoint com variáveis: https://minhaapi.com.br/relatorio?empresa={empresa}&data={data}. Os parâmetros ficariam assim: empresa como Fixo com valor 1, e data como Data Ref. com formato YYYY-MM-DD.

Opções de Autorização

Quando a API exige autorização de acesso, cadastre um destes tipos:

  • Basic Authorization: informe usuário e senha de acesso.

  • AWS Signature: para APIs no ambiente da AWS (Amazon Web Services). Informe os campos AWS Access Key ID, AWS Secret Access Key, ServiceCode e Region Code.

  • Bearer Token: informe o token.

  • Rota de Autenticação: configura uma API para obter o token de acesso, que é então usado na API que consulta os dados. Preencha a Chave do Parâmetro (nome do parâmetro de autenticação enviado no cabeçalho durante a execução) e o Prefixo (texto adicionado antes do valor obtido). Em seguida, clique em Configurar nova rota para definir a API que obtém o token, selecionando um campo para usar como token. Por exemplo, se o retorno for um token Bearer, use Authorization como chave e Bearer como prefixo.

Aba Cabeçalho

Você pode cadastrar parâmetros de cabeçalho (header), com os mesmos dois tipos disponíveis na URL:

  • Fixo: preenchido com um valor fixo, como o código da empresa ou a moeda desejada.

  • Data Ref.: envia a data de referência da execução. Na edição do fluxo vale a data de simulação; na execução vale a data de referência informada.

Aba Corpo

Disponível quando o método é POST. Configure:

  • Tipo de conteúdo: informe o formato do corpo. As opções são JSON (application/json), XML (application/xml) e XML (text/xml).

  • Parâmetros de Corpo: cadastre parâmetros do corpo da requisição, nos tipos Fixo (valor fixo) ou Data Ref. (data de referência da execução).

As variáveis são declaradas no corpo entre chaves. Por exemplo, para enviar empresa e data, o corpo seria { "codigoempresa": "{empresa}", "datacompetencia": "{data}" }, com os parâmetros empresa como Fixo (valor 1) e data como Data Ref. (formato YYYY-MM-DD).

Aba Retorno

Defina aqui quais campos da API serão usados como colunas de saída (etapa obrigatória).

  1. Executar Conexão: clique para executar a chamada na API.

  2. Configurar colunas: após a conexão, a plataforma exibe a lista de campos disponíveis. Os ícones indicam o tipo de campo:

  • Ícone #: campo de índice, exibido quando há uma lista de dados.

  • Ícone @: campo retornado pela API.

  • Ícone { }: uma lista de dados.

  1. Selecione os campos que deseja usar. Cada campo selecionado entra na lista abaixo com Origem (origem do campo na árvore de dados), Nome da Coluna, Amostra (primeiro valor encontrado) e Tipo de Dados (tipo identificado). Quando o tipo for Data, selecione ao lado o formato da data.

  2. Salvar: grava as configurações. Para sair sem salvar e voltar ao Designer, use Fechar.

Artigos relacionados

  • Etapa Transformar SQL

  • Etapa Dattos IA

Isso foi útil?
Isso foi útil?