A etapa de API do Flow Builder permite fazer chamadas de API definidas no formato JSON (XML não é compatível).
Componentes de uma chamada de API
Uma chamada de API no Flow Builder é composta pelos seguintes elementos:
Componente | Descrição |
|---|---|
Método HTTP | Especifica o tipo de ação a ser realizada no recurso. Métodos compatíveis: GET, POST, PUT, DELETE, PATCH. |
URL | O endereço do endpoint da API que está sendo acessada. |
Cabeçalhos | Informações adicionais enviadas com a solicitação, como autenticação ou tipo de conteúdo. Os cabeçalhos são pares de chave-valor, com os valores sempre tratados como strings. |
Corpo | Os dados enviados com a solicitação, formatados em JSON. |
Salvando dados da resposta da API
Você pode armazenar partes ou a totalidade da resposta da API (no formato JSON) em variáveis. Isso é feito usando uma consulta JMESPath, que extrai e manipula os dados da resposta JSON.
Visão geral do JMESPath:
JMESPath é uma linguagem de consulta usada para navegar e extrair dados de JSON. Para obter mais detalhes, visite asespecificações e a API de o tutorial.
Configurando uma consulta JMESPath:
Use a aba JMESPath do Parsing Helper.
Cole um exemplo da resposta da API no campo “valor JMESpath”.
JSON**Example Response** { "data": { "places": [ { "label": "Paris (tous aéroports)", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "PAR", "parent": null, "type": "area" }, { "label": "Paris Orly", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "ORY", "parent": "PAR", "type": "airport" }, { "label": "Paris Roissy/Charles de Gaulle", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "CDG", "parent": "PAR", "type": "airport" }, { "label": "Paris - Beauvais", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "BVA", "parent": "PAR", "type": "airport" }, { "label": "Paris Vatry", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "XCR", "parent": "PAR", "type": "airport" } ] } }Insira a consulta JMESPath no campo “Modelo”.
Exemplo de consulta:
data.places[0]
Clique em “Enviar” para verificar se o valor “Renderizar” é o que você espera salvar em uma variável.
JSON**Example Render { "label": "Paris (tous aéroports)", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "PAR", "parent": null, "type": "area" }**
☁️ A etapa de API do Flow Builder não é compatível com filtros JMESPath personalizados, como approx, remove_accents, belongs_to, replace, replace_all, unique e remove_duplicates.