Ikoula API PlatformInstall

Overview

This node integrates with the Ikoula Platform API to manage and retrieve information about platforms hosted on Ikoula. Specifically, the "List Platform Records" operation fetches a list of records (referred to as dossiers) associated with a specified platform. This is useful for users who want to programmatically access detailed data about their platform's records for monitoring, reporting, or automation purposes.

Practical examples include:

• Automatically retrieving all records linked to a platform to generate reports.
• Integrating platform record data into dashboards or other systems.
• Triggering workflows based on the presence or status of certain records.

Properties

Output

The node outputs an array of items where each item contains a json field holding the API response data. For the "List Platform Records" operation, this JSON data represents the list of records (dossiers) associated with the specified platform.

If the response format is set to XML, the output will contain the raw XML string under the data property inside the json field.

Example JSON output structure (simplified):

{
  "json": {
    // Parsed JSON object representing platform records
  }
}

If XML format is selected:

{
  "json": {
    "data": "<xml>...</xml>"
  }
}

No binary data output is produced by this node.

Dependencies

• Requires valid credentials for the Ikoula API, including email, password, and optionally a custom API URL.
• The password is encrypted using RSA public key encryption before being sent.
• The node makes HTTP GET requests to the Ikoula API endpoints.
• No additional external dependencies beyond standard n8n HTTP request helpers.

Troubleshooting

• No credentials provided!
  This error occurs if the node is executed without proper API credentials configured. Ensure that the required API authentication details are set up correctly in n8n credentials.

• API request failures
  If the API returns errors (e.g., invalid platform ID, network issues), the node will throw exceptions unless "Continue On Fail" is enabled. Verify platform IDs and network connectivity.

• Incorrect response format
  Selecting XML format returns raw XML strings; downstream nodes expecting JSON may fail. Use JSON format for easier integration unless XML is specifically needed.

• Encryption issues
  The password is encrypted with a hardcoded RSA public key. If the API changes its key or encryption method, authentication will fail.

Links and References

• Ikoula API Documentation (general reference for API endpoints)
• n8n HTTP Request Node Documentation (for understanding HTTP request handling)

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