Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

The node named "Ajax" is designed to interact with the Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Access Control" resource with the "Format Access Card" operation. This node facilitates sending requests to the Ajax backend to perform various actions or retrieve data.

For the "Format Access Card" operation under the "Access Control" resource, the node formats an access card for a specified user within a given hub. This can be useful in scenarios where you need to generate or prepare access credentials/cards programmatically for users in a security or building management system.

Practical examples:

  • Automatically generating access cards for new employees when they are added to a hub.
  • Formatting or updating access cards remotely via workflow automation without manual intervention.

Properties

Name Meaning
User Id The unique identifier of the user for whom the access card will be formatted.
Hub Id The unique identifier of the hub (location or group) where the access card applies.

These properties are required inputs for the "Format Access Card" operation and must be provided to specify which user's access card should be formatted and in which hub context.

Output

The node outputs JSON data representing the result of the "Format Access Card" operation. While the exact structure is not explicitly detailed in the source snippet, it typically includes information about the formatted access card such as status, card details, or confirmation of successful formatting.

If the node supports binary data output (not shown here), it would likely represent the actual access card data or related files (e.g., card images or encoded credentials).

Dependencies

  • Requires an API key credential to authenticate with the Ajax API service.
  • 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 requires proper configuration of the API authentication credential in n8n to function correctly.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key credential for the Ajax API is correctly configured and has sufficient permissions.
  • Invalid User Id or Hub Id: Providing incorrect or non-existent identifiers may cause the operation to fail or return errors. Verify these IDs before execution.
  • Network or connectivity issues: Since the node communicates with an external API, network problems can cause timeouts or failures.
  • Unexpected API responses: If the Ajax API changes or returns unexpected data, the node might throw errors. Check the API documentation and update the node or credentials accordingly.

Common error messages might include authentication failures, resource not found, or validation errors related to input parameters.

Links and References

Discussion