PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)

Overview

The PortaOne node for n8n enables users to interact with the PortaOne API, specifically for managing rate information.
For the Rate Management resource and the Add (create) operation, this node allows you to add new rate entries to your PortaOne system. This is useful in telecom billing scenarios where you need to programmatically update or expand your rate tables, such as adding new destination rates, updating pricing intervals, or configuring special tariffs.

Practical examples:

  • Automatically add new call rates when expanding into new countries.
  • Update off-peak and peak pricing structures based on business rules.
  • Integrate with other systems to synchronize rate changes.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
AdditionalFields A collection of optional fields to define the details of the rate being added. Includes:
- Country (ISO 3166-1 alpha-2 code)
- Description
- Destination prefix pattern
- Destination Group
- Discontinued status
- Editable (1/0)
- Effective From
- Effective Now (1/0)
- Forbidden
- Formula
- Hidden
- Huntshop
- Dest ID
- Destination Group ID
- Offpeak ID
- Rate ID
- Rate Formula ID
- Tariff ID
- Inactive From
- Inter Intra State Enabled (1/0)
- Interval 1
- Interval N
- ISO 3166 1 A2
- Network
- Op Huntstop
- Op Interval 1
- Op Interval N
- Op Preference
- Op Price 1
- Op Price N
- Op Route Category
- Preference
- Price 1
- Price N
- Rate Unit
- Unit
- Reverse Rating
- Route Category
- Special Price N
- Special Price 1
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 if simplification is enabled.

Output

  • By default, the node outputs a json object containing the result of the "add rate" operation from the PortaOne API.
  • If Simplify is enabled, only the specified property (via SimplifyPath) or a simplified structure will be returned.
  • The output typically includes confirmation of the created rate and any relevant identifiers or status messages from the API.
  • Binary data: This node does not output binary data; all output is in JSON format.

Dependencies

  • External Services: Requires access to a PortaOne instance with API enabled.
  • API Keys / Credentials:
    • For Token Authentication: PortaOne API token credentials.
    • For Basic Authentication: PortaOne username and password credentials.
  • n8n Configuration: Ensure the appropriate credentials are set up in n8n under "portaOneTokenApi" or "portaOneBasicApi".

Troubleshooting

Common Issues:

  • Authentication errors: Occur if incorrect credentials are provided or the selected authentication method does not match the credential type.
  • Missing required fields: Some rate fields may be mandatory depending on your PortaOne configuration. Ensure all necessary fields are filled in within AdditionalFields.
  • Invalid field values: Supplying invalid country codes, date formats, or numeric values can cause API errors.

Error Messages & Resolutions:

  • "Invalid credentials": Check your PortaOne credentials and ensure the correct authentication method is selected.
  • "Missing required parameter": Review the AdditionalFields and provide all required information for the rate entry.
  • "API connection failed": Verify network connectivity and that the PortaOne API endpoint is accessible from your n8n instance.

Links and References

Discussion