El paso de API de Flow Builder permite realizar llamadas a API definidas en formato JSON (no se admite XML).
Componentes de una llamada a API
Una llamada a API en Flow Builder se compone de los siguientes elementos:
Componente | Descripción |
|---|---|
Método HTTP | Especifica el tipo de acción que se realizará en el recurso. Métodos admitidos: GET, POST, PUT, DELETE, PATCH. |
URL | La dirección del endpoint de la API a la que se accede. |
Encabezados | Información adicional enviada con la solicitud, como la autenticación o el tipo de contenido. Los encabezados son pares clave-valor y sus valores siempre se tratan como cadenas. |
Cuerpo | Los datos enviados con la solicitud, con formato JSON. |
Guardar datos de la respuesta de la API
Puedes guardar partes o la totalidad de la respuesta de la API (en formato JSON) en variables. Esto se hace mediante una consulta JMESPath, que extrae y manipula los datos de la respuesta JSON.
Descripción general de JMESPath:
JMESPath es un lenguaje de consulta que se utiliza para navegar por los datos JSON y extraerlos. Para obtener más información, visita las especificaciones y la API de tutorial.
Configurar una consulta JMESPath:
Usa la pestaña JMESPath del Asistente de análisis.
Pega un ejemplo de la respuesta de la API en el campo «valor de 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" } ] } }Introduce la consulta JMESPath en el campo «Plantilla».
Ejemplo de consulta:
data.places[0]
Haz clic en «Enviar» para verificar que el valor de «Renderizar» sea el esperado para guardarlo en una variable.
JSON**Example Render { "label": "Paris (tous aéroports)", "country": { "iso": "FR", "label": "France" }, "city": "Paris", "id": "PAR", "parent": null, "type": "area" }**
☁️ El paso de API de Flow Builder no admite filtros JMESPath personalizados como approx, remove_accents, belongs_to, replace, replace_all, unique y remove_duplicates.