Ikoula Business API
Actions9
Overview
This node integrates with the Ikoula Business API to manage business operations related to domain and service orders, invoice details, payment methods, and account terminations. Specifically, the Order Domain operation allows users to order a new domain by specifying domain details, billing cycle, payment method, and optional promotional codes or EPP codes for transfers.
Common scenarios where this node is beneficial include:
- Automating domain registration workflows within an n8n automation.
- Managing domain portfolio by ordering new domains programmatically.
- Integrating domain ordering into broader business management processes such as invoicing or service provisioning.
Example use case: Automatically order a domain when a customer signs up on your platform, using their chosen domain name, billing preferences, and payment method stored in your system.
Properties
| Name | Meaning |
|---|---|
| Action | The action to perform on the domain (e.g., register, transfer). |
| Billing Cycle | The billing cycle for the domain (e.g., monthly, yearly). |
| Domain | The domain name to order (e.g., example.com). |
| EPP Code | The EPP code required for domain transfer (optional, used only if transferring a domain). |
| Payment Method ID | The identifier of the payment method to be used for the order. |
| Promotional Code | A promotional code to apply discounts or offers (optional). |
| TLD ID | The identifier of the top-level domain (TLD) to order (e.g., .com, .net). |
| Response Format | The format of the API response; options are JSON or XML. |
Output
The node outputs the API response in the json field of each item. The structure depends on the API response format selected (JSON or XML):
- If JSON is selected, the output will be a parsed JSON object representing the result of the domain order request.
- If XML is selected, the output will contain the raw XML response as a string under the
dataproperty.
No binary data output is produced by this node.
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 Node.js crypto and HTTP libraries.
Troubleshooting
- No credentials provided!: This error occurs if the node is executed without proper API credentials configured. Ensure you have set up the required API authentication credentials in n8n.
- Invalid domain or missing required fields: The API may reject requests if mandatory properties like domain name, TLD ID, or payment method ID are missing or invalid. Double-check input parameters.
- API errors or network issues: If the API returns errors or times out, verify network connectivity and that the API endpoint URL is correct.
- Incorrect EPP code for domain transfer: When transferring a domain, ensure the EPP code is accurate; otherwise, the transfer will fail.
- If the node is set to continue on failure, errors will be returned in the output JSON under an
errorproperty for easier debugging.
Links and References
- Ikoula Business API Documentation (general reference, actual link may vary)
- n8n Documentation - Creating Custom Nodes
- RSA Public Key Encryption in Node.js