Ikoula API Platform icon

Ikoula API Platform

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

Actions12

Overview

This node interacts with the Ikoula Platform API to retrieve detailed information about platform records (dossiers). Specifically, the "Get Record Details" operation fetches details of a specific record within a given platform. This is useful for users who manage multiple platforms and need to programmatically access detailed data about individual records or dossiers associated with those platforms.

Practical examples include:

  • Retrieving billing or configuration details of a particular record in a platform.
  • Automating monitoring or reporting workflows that require up-to-date record information.
  • Integrating platform record data into other systems or dashboards.

Properties

Name Meaning
Platform ID The unique numeric identifier of the platform containing the record.
Dossier ID The unique numeric identifier of the dossier/record whose details are to be retrieved.
Response Format The format of the API response; can be either JSON or XML.

Output

The output is an array of items where each item contains a json field holding the API response data for the requested record details.

  • If the response format is JSON, the json field contains a parsed JSON object representing the record details.
  • If the response format is XML, the json field contains the raw XML string under a data property.

No binary data output is produced by this node.

Example output structure when JSON format is selected:

{
  "json": {
    // Parsed JSON object with record details from the Ikoula Platform API
  }
}

If XML format is selected:

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

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 GET requests to the Ikoula API endpoints.
  • 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. Ensure you have configured the API authentication credentials correctly in n8n.

  • Invalid Platform ID or Dossier ID
    If the platform or dossier IDs do not exist or are incorrect, the API may return errors or empty results. Verify the IDs before running the node.

  • API Response Format Issues
    Selecting XML format returns raw XML as a string. Downstream nodes expecting JSON will fail unless XML parsing is added.

  • Network or API Errors
    Network issues or invalid API URLs can cause request failures. Check connectivity and API endpoint correctness.

  • Encryption Errors
    The password is encrypted with a hardcoded RSA public key. If the API changes its key, authentication will fail until updated.

Links and References

Discussion