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 comprehensive Ajax API, supporting multiple resources and operations. Specifically, for the Receiver resource and the Bind Hub To The Receiver operation, it enables users to associate a particular hub device with a receiver within a specified company account. This binding process is useful in scenarios where physical or logical hubs need to be linked to receivers for management, monitoring, or control purposes.

Practical examples include:

  • Integrating a new hub into an existing receiver setup in a security system.
  • Automating the configuration of devices by programmatically linking hubs to receivers based on company and account data.
  • Managing device relationships in large installations where manual binding would be inefficient.

Properties

Name Meaning
Company Id Identifier of the company owning the receiver and hub; required to scope the operation.
Receiver Id Unique identifier of the receiver to which the hub will be bound.
Hub Id Unique identifier of the hub device that needs to be bound to the receiver.
Account Number Account number associated with the company and devices; used for authorization/context.

Output

The node outputs JSON data representing the result of the bind operation. This typically includes confirmation details such as success status, identifiers of the bound entities, timestamps, or error messages if the binding failed. The exact structure depends on the Ajax API response but generally confirms whether the hub was successfully linked to the receiver.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API service.
  • The node depends on the external Ajax API endpoint that manages device bindings.
  • Proper configuration of the API credentials within n8n is necessary for successful execution.

Troubleshooting

  • Common Issues:

    • Invalid or missing Company Id, Receiver Id, Hub Id, or Account Number can cause failures.
    • Authentication errors due to incorrect or expired API credentials.
    • Network connectivity issues preventing access to the Ajax API.
    • Attempting to bind a hub that is already bound or does not exist.

  • Error Messages:

    • Authorization errors indicating invalid API keys require checking and updating credentials.
    • Validation errors about missing or malformed input properties suggest verifying all required fields are correctly filled.
    • API response errors related to device states (e.g., "Hub not found" or "Receiver not found") indicate verifying the existence and correctness of provided IDs.

Resolving these typically involves ensuring correct input values, valid credentials, and stable network connections.

Links and References

Discussion