Ikoula Business API icon

Ikoula Business API

Interact with Ikoula Business API for business operations management. Developed by Ascenzia - www.ascenzia.fr
Join our community

Actions9

Overview

This node integrates with the Ikoula Business API to manage various business operations related to services, domains, invoices, and account terminations. Specifically, for the Order Service operation under the Business resource, it allows users to place new service orders by specifying product details, payment methods, billing cycles, and optional promotional codes or custom options.

Common scenarios where this node is beneficial include:

  • Automating the ordering of hosting or cloud services as part of a larger workflow.
  • Integrating service provisioning into customer onboarding processes.
  • Applying promotional codes dynamically during service purchases.
  • Managing billing cycles and payment methods programmatically.

For example, a user could automate ordering a web hosting service with a monthly billing cycle, using a specific payment method and applying a promotional discount code.

Properties

Name Meaning
Service Order Data A collection of fields describing the service order:
- Billing Cycle The billing cycle for the service (e.g., monthly, yearly).
- Custom Options Optional custom configuration options for the service.
- Domain Optional domain associated with the service.
- Payment Method ID The numeric ID of the payment method to be used for the order.
- Product ID The numeric ID of the product to order.
- Promotional Code Optional promotional code to apply to the order.
Response Format The format of the API response; can be either JSON or XML.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains a json field with the API response data from the Ikoula Business API.

  • For the Order Service operation, the json output typically includes details about the newly created service order such as order confirmation, status, and any relevant metadata returned by the API.
  • If the response format is XML, the raw XML string is included in the json.data field.
  • In case of errors, the output will contain an error field with the error message.

The node does not output binary data.

Dependencies

  • Requires valid credentials for the Ikoula Business API, including email, password, and optionally a custom API URL.
  • The password is encrypted using RSA public key encryption before being sent.
  • The node uses HTTP requests to communicate with the Ikoula API endpoints.
  • No additional external dependencies beyond standard n8n helpers and Node.js crypto module.

Troubleshooting

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

  • Invalid or missing required parameters
    The node requires certain fields like productId, paymentMethodId, and facturationCycle for ordering a service. Missing or invalid values may cause API errors.

  • API request failures
    Network issues, incorrect API URLs, or invalid credentials can cause HTTP request failures. Verify connectivity and credential correctness.

  • Response format issues
    Selecting XML format returns raw XML strings which might require parsing downstream. Choose JSON format for easier handling within n8n.

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

Links and References

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

Discussion