Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). It supports multiple resources and operations, including user management tasks such as updating a bound user's specific keypad password. The node is useful for automating security system configurations, managing users, hubs, devices, and other related entities within the Ajax ecosystem.

A practical example of its use is updating the keypad password for a user bound to a particular hub, which can be part of a workflow that manages access control dynamically based on external triggers or schedules.

Properties

Name Meaning
User Id Identifier of the user whose bound keypad password is to be updated.
Hub Id Identifier of the hub associated with the user and keypad.
Bound User Id Identifier of the bound user whose keypad password will be changed.
New Password The new keypad password to set, consisting of 4-6 digits.

These properties are required when performing the "Update Bound User Specific Key Pad Password" operation under the "User" resource.

Output

The node outputs JSON data representing the result of the API call to update the keypad password. This typically includes confirmation of success or details about the updated user/keypad state. The exact structure depends on the Ajax API response but generally contains status information and any relevant metadata.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the @digital-boss/n8n-designpatterns package for operation resolution and execution.
  • Uses internal backend modules for HTTP communication and state management.
  • The node must be configured with valid credentials named generically as "an API key credential" for the Ajax API.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect user, hub, or bound user IDs may lead to "not found" errors.
    • Providing a new password outside the 4-6 digit range might be rejected by the API.
  • Error messages:
    • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
    • Validation errors: Ensure all required fields are provided and adhere to expected formats.
    • Network or timeout errors: Check connectivity to the Ajax API endpoint and retry.

Links and References

  • Ajax API Documentation (general reference for the Ajax platform)
  • n8n documentation on creating custom nodes and using credentials: https://docs.n8n.io/
    (Note: Specific links to the internal packages used are not publicly available.)

Discussion