Basic Integration icon

Basic Integration

Basic Integration API node

Actions5

Overview

The node named "Basic Integration" provides an API interface to perform various operations on different resources, including "Integrations". For the Create operation on the "Integrations" resource, it allows users to send XML data representing items and parameters to an external system via an API. This is useful for integrating with systems that require structured XML input for creating or updating records, such as ERP or inventory management platforms.

Typical use cases include:

  • Importing or syncing product/item data into an external system.
  • Automating data entry by sending bulk XML-formatted data.
  • Custom integrations where XML is the required data format for communication.

For example, a user can provide an XML string describing multiple items with their codes, names, groups, units, etc., and the node will send this data to create those items in the target system.

Properties

Name Meaning
Data XML The main XML string containing the data to be created or updated. It must be a valid XML representation of the items or entities to process. Example provided shows item details with nested units.
Param XML Optional XML string specifying parameters controlling the operation's behavior, such as replication mode, checks, campaign application, and other flags. Defaults are provided if not set.
Additional Fields A collection of optional fields:
- Logo Tenant: Identifier for the tenant; if empty, uses credential default.
- Logo Firm Number: Firm number identifier; if empty, uses credential default.
- Logo Firm Period: Period identifier; if empty, uses credential default.

Output

The node outputs JSON data representing the response from the integration API after attempting the create operation. The structure depends on the external system's response but generally includes success indicators, error messages (if any), or created record details.

No binary data output is indicated.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the external integration service.
  • The node relies on bundled resource functions (createIntegration method) which handle the actual API call.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Common issues:

    • Invalid or malformed XML in the "Data XML" property can cause the API to reject the request.
    • Missing required fields in the XML may lead to errors or incomplete creation.
    • Incorrect or missing API credentials will result in authentication failures.
    • If the optional "Param XML" is malformed, default parameters will be used, which might not fit all scenarios.

  • Error messages:

    • Errors returned from the API are captured and included in the output JSON under an error field when "Continue On Fail" is enabled.
    • Authentication errors typically indicate invalid or missing API keys.
    • XML parsing or validation errors suggest checking the XML syntax and structure.

  • Resolution tips:

    • Validate XML strings before using them in the node.
    • Ensure API credentials are correctly set up and have necessary permissions.
    • Use the "Additional Fields" to specify tenant, firm number, and period if defaults do not apply.

Links and References

  • No direct external links are provided in the source code.
  • Users should refer to the documentation of the target integration system for XML schema details and parameter meanings.
  • General XML validation tools can help prepare correct XML inputs.

Discussion