Ikoula API IKIC icon

Ikoula API IKIC

Interact with Ikoula IKIC API for account management. Developed by Ascenzia - www.ascenzia.fr
Join our community

Actions3

Overview

This node interacts with the Ikoula IKIC API to manage and retrieve information about IKIC accounts. Specifically, for the "Get Account Statistics" operation, it fetches statistical data related to a specific IKIC account subscription. This is useful for users who want to monitor usage or performance metrics of their IKIC accounts over a defined period.

Practical examples include:

  • Retrieving monthly or custom-period statistics for an IKIC hosting subscription.
  • Integrating account usage data into dashboards or reports.
  • Automating monitoring workflows that trigger alerts based on account statistics.

Properties

Name Meaning
Subscription ID The unique numeric identifier of the IKIC subscription/account for which stats are fetched. Required.
Period Optional string specifying the time period for which statistics should be retrieved (e.g., "last_month", "2023-Q1"). If omitted, defaults to all available data.
Response Format The format in which the API response is returned. Options: JSON or XML. Defaults to JSON.

Output

The node outputs an array of items where each item's json property contains the response from the Ikoula API:

  • When the response format is JSON, the output is parsed into a JavaScript object representing the account statistics.
  • When the response format is XML, the raw XML string is returned inside the data field of the json output.

Each output item corresponds to one input item processed, paired by index.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Ikoula API, including an email, password, and optionally a custom API URL.
  • The password is encrypted using RSA public key encryption before being sent.
  • The node makes HTTP requests to the Ikoula API endpoint (https://api.ikoula.com by default).
  • No additional external dependencies beyond standard n8n helpers and Node.js crypto module.

Troubleshooting

  • No credentials provided!
    Error thrown if the required API credentials are missing or not configured properly. Ensure you have set up the necessary API authentication details in n8n credentials.

  • Invalid Subscription ID
    If the subscription ID does not exist or is incorrect, the API may return an error or empty results. Verify the subscription ID is correct.

  • Incorrect Period Format
    Providing an invalid or unsupported period string may cause the API to ignore the parameter or return an error. Use documented period formats supported by Ikoula.

  • Response Format Issues
    Selecting XML format returns raw XML as a string; downstream nodes expecting JSON will fail. Choose JSON format unless you specifically need XML.

  • Network or API Errors
    Network issues or API downtime can cause request failures. Check network connectivity and Ikoula API status.

Links and References

Discussion