Ikoula Business APIInstall

Overview

This node interacts with the Ikoula Business API to manage various business operations related to accounts, services, domains, invoices, and terminations. Specifically, the "Get Termination Info" operation retrieves information about cancellable services and the list of reasons for termination. This is useful for users who want to programmatically obtain details on which services can be terminated and understand the valid reasons that can be provided when initiating a termination.

Practical examples include:

• Fetching termination options before allowing a user to cancel a service in a customer portal.
• Automating workflows that require validation of termination reasons or checking if a service is eligible for cancellation.

Properties

Output

The output contains a JSON object (or XML string if chosen) representing the termination information retrieved from the API. This includes:

• A list of services that can be cancelled.
• A list of valid reasons for termination.

The output is structured as the direct API response under the json field. If the response format is XML, the raw XML string is returned inside the data property of the JSON output.

No binary data output is produced by this operation.

Dependencies

• Requires an API key credential for authentication with the Ikoula Business API.
• The node uses RSA public key encryption to encrypt the password before sending it to the API.
• The base URL for the API defaults to https://api.ikoula.com but can be overridden via credentials.
• The node requires network access to the Ikoula API endpoints.

Troubleshooting

• No credentials provided!
  This error occurs if the required API authentication credentials are missing. Ensure you have configured the API key credential properly in n8n.

• HTTP request errors
  Network issues, invalid credentials, or incorrect parameters may cause HTTP errors. Verify your credentials, parameter values, and network connectivity.

• Invalid response format
  If the selected response format does not match the expected content type, parsing errors might occur. Choose between JSON or XML according to your needs.

• Continue on Fail
  If enabled, the node will continue processing subsequent items even if one fails, returning the error message in the output.

Links and References

• Ikoula Business API Documentation (general reference, actual link may vary)
• n8n Documentation - Creating Custom Nodes
• Node.js Crypto Module - Public Key Encryption

If you need details on other operations or resources, feel free to ask!