Etapa API Rest

A etapa API Rest importa dados de qualquer sistema que disponibilize uma API REST — o retorno em JSON é convertido automaticamente em colunas tabulares para uso no fluxo. Use quando o sistema não tem conector nativo na plataforma, ou quando o dado que você precisa não está nos relatórios do conector. A API Rest fica na categoria Fonte de Dados da barra de ferramentas.

Como configurar

A configuração é organizada em quatro abas.

Aba API

• Nome: identifica a etapa no fluxo.

• Método HTTP: GET ou POST, conforme a API consultada.

• URL do endpoint: endereço da API.

• Possui paginação: ative quando a API divide o retorno em páginas — a plataforma percorre as páginas automaticamente (por número de página ou por deslocamento, conforme a API).

• Variáveis de URL: parâmetros dinâmicos da chamada, incluindo valores calculados a partir da data de referência da execução.

• Opções de Autorização: habilita a autenticação — são suportados usuário e senha (Basic), token (Bearer), assinatura HTTP e assinatura AWS, além de rota de autenticação (uma chamada prévia que obtém o token usado nas chamadas seguintes).

Aba Cabeçalho

• Variáveis de Cabeçalho: headers HTTP adicionais exigidos pela API (ex.: Content-Type).

Aba Corpo

• Corpo da requisição, para métodos POST.

Aba Retorno

• Executar Conexão: testa a chamada diretamente do editor e mostra o status, o tempo e o tamanho da resposta.

• Navegador da estrutura: o JSON retornado aparece como uma árvore — marque os campos que deseja importar.

• Mapeamento de colunas: para cada campo selecionado, defina o nome da coluna e o tipo de dado (alfanumérico, numérico ou data).

Exemplo de utilização

Uma empresa precisa da cotação diária do dólar para converter saldos. Na etapa API Rest, informa a URL da API de câmbio com uma variável de data preenchida pela data de referência, testa a conexão na aba Retorno, seleciona os campos de data e valor de compra na árvore do JSON e nomeia as colunas. A cada execução, a cotação do dia entra no fluxo e pode ser cruzada com as demais fontes por uma etapa Procurar.

Artigos relacionados

• Integrações customizadas via API Rest e conectores SQL

• Etapa Banco de Dados

• Etapa ERP