Nuvem Solution icon

Nuvem Solution

Interact with Nuvem Solution API

Actions120

Cliente → Get Cidades

AI-generated

Overview

This node interacts with the Nuvem Solution API to retrieve a list of cities ("Cidades") related to customers ("Cliente"). It supports pagination and filtering by city name, IBGE code (a Brazilian geographic code), and state abbreviation (UF). This operation is useful when you need to fetch city data for customer-related processes, such as populating dropdowns, validating addresses, or integrating geographic information into workflows.

Practical examples:

  • Fetching a paginated list of cities to display in a user interface.
  • Filtering cities by name or state to narrow down search results.
  • Using IBGE codes to match official geographic identifiers in data processing.

Properties

Name Meaning
Page Page number for pagination. Indicates which page of results to retrieve.
Page Size Number of items per page. Controls how many city records are returned per request.
Cidade Filter by city name. Returns only cities matching this name filter (partial or full).
Código IBGE Filter by IBGE code. Returns only cities matching the specified IBGE geographic code.
UF Filter by state abbreviation (UF). Returns only cities within the specified state.

Output

The output is a JSON array containing city objects retrieved from the API. Each object represents a city with its associated details as provided by the Nuvem Solution API. The exact structure depends on the API response but typically includes fields like city name, IBGE code, state (UF), and possibly other metadata.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Nuvem Solution API.
  • The node uses the base URL and authentication tokens obtained from these credentials.
  • Proper configuration of the API key credential in n8n is necessary before using this node.

Troubleshooting

  • Authentication errors: If the node fails due to authentication issues, verify that the API key credential is correctly configured with valid keys and tokens.
  • Invalid filters: Providing invalid or malformed filter values (e.g., incorrect IBGE codes or UF abbreviations) may result in empty responses or errors.
  • Pagination limits: Requesting pages beyond the available range will return empty results; ensure the page number and size are within valid bounds.
  • Network issues: Connectivity problems with the Nuvem Solution API endpoint can cause request failures; check network access and API availability.

Common error messages:

  • "Authentication failed: Invalid response from server" indicates credential or connectivity problems.
  • "The operation "getCidades" is not supported!" would indicate a misconfiguration or unsupported operation selection (unlikely if using the provided properties).

Links and References

This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion