PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)
Join our community

Actions34

Overview

This n8n node allows you to add a new customer to the PortaOne system via its API. It is designed for scenarios where automated customer creation and management are required, such as onboarding new users, integrating CRM systems, or batch-importing customer data. For example, you could use this node in an automation workflow that creates a customer record whenever a new signup occurs on your website.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Customer Info A collection of fields describing the customer's details, such as address, contact information, billing settings, credit limits, status, and more. Each sub-field has its own meaning (see below for examples).
AdditionalFields Optional additional settings, e.g., Generate Web Password (Yes/No).
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 when simplifying output.

Examples of fields within "Customer Info":

  • Address Line 1, Address Line 2: Customer's address.
  • Api Token: The API token of the customer.
  • Balance: The subject's balance.
  • Bill Status: The subject status. Options: open, suspended, closed, exported, deactivated, inactive.
  • Blocked: Indicates whether a customer's calls should be blocked. Options: No, Yes.
  • Email: The subject's email address.
  • Credit Limit: The customer's credit limit value.
  • Country: The code of the country in ISO 3166-1 alpha-2 format.
  • ...and many more.

Output

The node returns the result of the customer creation operation from the PortaOne API. The structure of the json output field depends on the API response and the "Simplify" option:

  • If "Simplify" is false:
    The full API response is returned as JSON, which may include all details about the created customer, status codes, and any messages from the API.

  • If "Simplify" is true:
    Only the property specified by "SimplifyPath" (if provided) or a simplified version of the response is returned.

Example output (simplified):

{
  "i_customer": 12345,
  "name": "John Doe",
  "status": "active"
}

Note: Actual output fields depend on the API and selected options.

Dependencies

  • External Services: Requires access to a PortaOne instance with API enabled.
  • API Credentials: You must provide either a Token or Basic Authentication credentials, configured in n8n as "portaOneTokenApi" or "portaOneBasicApi".
  • n8n Configuration: Ensure the appropriate credentials are set up in n8n's credential store.

Troubleshooting

  • Authentication Errors:

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

  • Missing Required Fields:

    • Error message: "Missing required parameter" or similar.
      Resolution: Ensure all mandatory fields in "Customer Info" are filled out.

  • API Connection Issues:

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

  • Unexpected Output/Simplification Issues:

    • Error message: "Property not found at SimplifyPath".
      Resolution: Double-check the path provided in "SimplifyPath" matches the structure of the API response.

Links and References

Tip: For best results, consult the PortaOne API documentation for detailed descriptions of each customer field and their allowed values.

Discussion