Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with a backend Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Device" resource with an operation to "Send Command To Unbind Device To Range Extender." The node facilitates sending commands or requests to the Ajax system, enabling automation and integration scenarios such as managing devices, hubs, users, and other entities within the Ajax ecosystem.

A practical example for the specified operation would be unbinding a device from a range extender by providing the user ID, hub ID, and device ID. This could be useful in scenarios where a device needs to be removed from a network extension setup remotely via automation workflows.

Properties

Name Meaning
User Id Identifier of the user who owns or manages the device. Required to authenticate context.
Hub Id Identifier of the hub to which the device is connected. Required to specify the target hub.
Device Id Identifier of the device to be unbound from the range extender. Required to specify the exact device.

Output

The node outputs JSON data representing the response from the Ajax API after executing the command. This typically includes status information about the unbinding operation, success confirmation, or error details if the operation failed.

If the node supports binary data output, it would represent any binary payload returned by the API, but based on the provided code and operation, the output is primarily JSON structured data related to the device unbinding command.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external Ajax backend service accessible via HTTP.
  • Uses internal helper classes for state management, HTTP client communication, and operation resolution/execution.
  • The node expects proper configuration of the API credentials within n8n to function correctly.

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Incorrect or missing required properties (User Id, Hub Id, Device Id) will result in errors or no action.
    • Network connectivity issues to the Ajax backend can cause timeouts or request failures.

  • Error Messages:

    • Authentication errors indicate problems with the provided API key; verify and update credentials.
    • Validation errors suggest missing or malformed input parameters; ensure all required fields are filled correctly.
    • Backend errors may include detailed messages from the Ajax API; review these to understand specific failure reasons.

Links and References

Discussion