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 "Pro" resource with a "Find User" operation. This node allows users to query user information from the Ajax system by specifying parameters such as login or phone number.

Common scenarios for this node include:

  • Retrieving user details based on their login name or phone number.
  • Integrating Ajax user data into workflows for automation or reporting.
  • Validating user existence before performing further actions in a workflow.

For example, a user might configure the node to find a user by their login to fetch their profile details and then use that data downstream in the workflow.

Properties

Name Meaning
Login The login identifier of the user to find. Optional string input.
Phone The phone number of the user to find. Optional string input.

These properties are used specifically when the Resource is set to "Pro" and the Operation is "Find User".

Output

The node outputs JSON data representing the user information retrieved from the Ajax API based on the provided search criteria (login or phone). The exact structure depends on the API response but typically includes user details such as identifiers, contact info, and other relevant attributes.

If the node supports binary data output, it would represent associated files or media related to the user, but this is not explicitly indicated in the provided code snippet.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external @digital-boss/n8n-designpatterns package for operation resolution and execution logic.
  • Uses internal backend modules for state management, HTTP client communication, and operation definitions.
  • The node expects proper configuration of the Ajax API credentials within n8n.

Troubleshooting

  • Missing or invalid API credentials: Ensure the API key credential is correctly configured and has sufficient permissions.
  • No user found: If neither login nor phone matches any user, the output may be empty or indicate no results.
  • Network issues: Connectivity problems with the Ajax API endpoint can cause errors; verify network access.
  • Incorrect property usage: Providing both login and phone as empty strings may result in no action; specify at least one parameter.
  • API changes: Updates to the Ajax API could affect response formats or available operations; keep the node version updated.

Links and References

Discussion