PortaOneInstall

Overview

The PortaOne node for n8n enables users to interact with the PortaOne API, specifically targeting the "Rate Management" resource and its "Search Rate List" operation. This operation allows users to search and retrieve lists of rate entries (such as call rates or tariffs) from their PortaOne system, applying various filters and options.

Common scenarios:

• Fetching a list of call rates for specific countries or destinations.
• Filtering rates by product, tariff, or description.
• Paginating through large sets of rate data.
• Integrating rate management data into automated workflows for reporting, billing, or analysis.

Practical examples:

• Retrieve all rates for a given country code to update a pricing table.
• Search for rates with a specific destination prefix for routing configuration.
• Export a filtered list of rates for auditing or compliance purposes.

Properties

Output

• By default, the node outputs the full JSON response from the PortaOne API for the "Search Rate List" operation.
• If Simplify is enabled, only the property specified by SimplifyPath (default: rate_list) is returned.
• The structure of the output typically includes:
  • rate_list: An array of rate objects, each containing details such as country, destination, rate, tariff, etc.
  • Other metadata fields may be present depending on the API response and selected options (e.g., total count if "Get Total" is enabled).

Example output (simplified):

{
  "rate_list": [
    {
      "country": "US",
      "destination": "123",
      "rate": 0.05,
      "tariff_id": 42,
      ...
    },
    ...
  ],
  "total": 100
}

• The actual fields inside each rate object depend on the PortaOne API schema.

Binary Data:
This node does not output binary data; all output is in JSON format.

Dependencies

• External Services: Requires access to a PortaOne API endpoint.
• API Credentials:
  • For Token Authentication: portaOneTokenApi credentials.
  • For Basic Authentication: portaOneBasicApi credentials.
• n8n Configuration: Ensure the appropriate credentials are set up in n8n under the node's credential types.

Troubleshooting

Common issues:

• Authentication errors:

  • Error message: "Invalid credentials" or "Unauthorized".
    • Resolution: Check that the correct authentication method and valid credentials are provided in n8n.

• Missing required fields:

  • Error message: "limit must be specified if offset is used" or similar.
    • Resolution: When specifying an offset, ensure you also provide a limit value.

• Empty results:

  • Possible causes: Filters are too restrictive, or there are no matching rates in the system.
    • Resolution: Adjust filter criteria in AdditionalFields.

• API connection errors:

  • Error message: "Unable to connect to PortaOne API".
    • Resolution: Verify network connectivity and correct API endpoint configuration.

Links and References

• PortaOne Official Documentation
• n8n Documentation: Creating Custom Nodes
• ISO 3166-1 alpha-2 Country Codes