PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)

Overview

The PortaOne - Rate Management: Batch Add Rate node allows users to add multiple rate records in bulk to the PortaOne system via its API. This is particularly useful for telecom operators or billing administrators who need to manage large sets of call rates, such as updating tariffs, introducing new destinations, or making mass changes to pricing structures efficiently.

Common scenarios:

  • Importing a new set of international calling rates.
  • Updating rates for multiple destinations at once.
  • Automating tariff management based on external data sources.

Practical example:
A telecom company receives updated wholesale rates from their provider and needs to update hundreds of destination rates in PortaOne. Using this node, they can upload all changes in one batch operation instead of editing each rate individually.


Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Rate Set of rates records. Each record includes fields such as Country (ISO code), Description, Destination, Destination Group, Discontinued, Editable (1/0), Effective From, Effective Now (1/0), Forbidden, Formula, etc.
Simplify Whether to simplify the output data. If enabled, the response will be reduced to essential information.
SimplifyPath Path to the property that should be returned. Used when simplifying output to extract a specific part of the response.

Note:
Each "Rate" entry supports a wide range of fields, including but not limited to:

  • Country (ISO 3166-1 alpha-2)
  • Description
  • Destination prefix pattern
  • Destination Group
  • Editable (1/0)
  • Effective dates
  • Price intervals
  • Routing priority
  • Network name
  • Special prices
  • And many more (see your input definition for full list).

Output

  • The node outputs a json field containing the result of the batch add operation.
  • The structure of the output depends on the API response and the "Simplify" option:
    • If Simplify is enabled, only the relevant or specified part (via SimplifyPath) of the response is returned.
    • If Simplify is disabled, the full API response is provided, which typically includes status, details of added rates, and any errors encountered.

Example output (simplified):

{
  "success": true,
  "addedRates": [
    {
      "country": "US",
      "destination": "1",
      "price_1": 0.01,
      ...
    },
    ...
  ],
  "errors": []
}
  • The node does not output binary data.

Dependencies

  • External Service: Requires access to a PortaOne instance with API enabled.
  • API Credentials:
    • For Token Authentication: portaOneTokenApi credentials.
    • For Basic Authentication: portaOneBasicApi credentials.
  • n8n Configuration: Ensure the appropriate credentials are configured in n8n under the node's credential options.

Troubleshooting

Common issues:

  • Authentication errors:
    • Error message: "Invalid credentials" or "Unauthorized".
      Resolution: Check that the correct authentication method and valid credentials are used.
  • Missing required fields in Rate records:
    • Error message: "Missing required parameter..."
      Resolution: Ensure all mandatory fields for each rate entry are filled out.
  • API connection failures:
    • Error message: "Could not connect to PortaOne API"
      Resolution: Verify network connectivity and API endpoint configuration.
  • Incorrect SimplifyPath:
    • Error message: "Property not found at path..."
      Resolution: Double-check the path provided in SimplifyPath matches the structure of the API response.

Links and References

Discussion