PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)
Join our community

Actions34

Overview

This node allows you to retrieve customer information from the PortaOne API using either Token or Basic Authentication. It is designed for scenarios where you need to fetch detailed or summary data about a specific customer, such as integrating customer records into your workflow, automating reporting, or enriching other systems with up-to-date customer details.

Practical examples:

  • Fetching a customer's profile by ID or login to display in a dashboard.
  • Retrieving extended customer information (e.g., main office, authorization info) for compliance or support automation.
  • Integrating customer data into CRM or ticketing workflows.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
AdditionalFields A collection of optional fields to refine the query and response:
- Aux Field Names: The names of additional fields to fetch.
- Detailed Info: Specifies whether detailed information will be returned (Yes/No).
- Effective Values: Whether to use values inherited from the customer class (Yes/No).
- Get Auth Info: Whether the customer's authorization parameters are included (Yes/No).
- Get Main Office Info: Whether to include main office (HQ) information (Yes/No).
- Get Rt Auth Info: Whether to include request tracker information (Yes/No).
- Get Time Zone Name: Whether to include timezone names (Yes/No).
- Customer ID: The unique ID of the customer record.
- Login: Customer's login.
- Name: The subject's name.
- Reference Number: The reference number (custom field).
- With Reseller Info: Whether to include reseller information (Yes/No).
Simplify Whether to simplify the output data. If enabled, only the property specified by "SimplifyPath" will be returned.
SimplifyPath Path to the property that should be returned when "Simplify" is enabled (default: customer_info).

Output

  • By default, the output is a JSON object containing customer information as returned by the PortaOne API.
  • If Simplify is enabled, only the property at the path specified by SimplifyPath (default: customer_info) will be returned.
  • The structure of the output depends on the selected additional fields and options; it typically includes customer details such as ID, name, login, and any requested extended information.

Example output (simplified):

{
  "customer_info": {
    "i_customer": 12345,
    "name": "Acme Corp",
    "login": "acme_corp",
    // ...other fields depending on options...
  }
}
  • This node does not output binary data.

Dependencies

  • External Services: Requires access to a PortaOne API endpoint.
  • API Credentials: You must provide valid credentials for either Token Authentication (portaOneTokenApi) or Basic Authentication (portaOneBasicApi).
  • n8n Configuration: Ensure the appropriate credentials are set up in n8n under the node's credential options.

Troubleshooting

  • Authentication Errors:

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

  • Missing Required Fields:

    • Error message: "Customer ID or Login required".
      Resolution: Ensure you provide at least one identifier (such as Customer ID or Login) in the AdditionalFields collection.

  • Empty or Unexpected Output:

    • Possible cause: Incorrect SimplifyPath or missing fields in the response.
      Resolution: Double-check the value of SimplifyPath and ensure the requested fields exist in the API response.

  • API Connection Issues:

    • Error message: "Network error" or "Failed to connect".
      Resolution: Verify network connectivity to the PortaOne API endpoint and check for firewall or proxy issues.

Links and References

Discussion