Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

Overview

This node, named "Ajax," is designed to interact with a specific Ajax API (version indicated in the code). It supports multiple resources and operations, including network-related functions such as updating general GSM settings for a company. The node acts as a flexible interface to perform various backend operations by sending HTTP requests through an internal HTTP client.

A common use case for this node is automating configuration changes or data retrieval from the Ajax system, such as updating GSM settings for a company's network hubs. For example, a user might update roaming permissions or enable/disable ICMP checks before connecting devices within a company's network infrastructure.

Properties

Name Meaning
Company Id Identifier of the company whose GSM settings are being updated.
Hub Id Identifier of the hub within the company network where settings will be applied.
Disable Icmp Before Connecting Boolean flag to disable ICMP ping checks before establishing a connection.
Virtual Operator Allowed Boolean flag indicating whether virtual operators are permitted on the network.
Roaming Enabled Boolean flag to enable or disable roaming capabilities for the company's GSM settings.

Output

The node outputs JSON data representing the result of the executed operation. This typically includes confirmation of the updated GSM settings or any relevant response data returned by the Ajax API after applying the changes.

If binary data were involved, it would represent files or media related to the operation, but in this context, the output is purely JSON structured data reflecting the network configuration state.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Uses an internal HTTP client to communicate with the backend Ajax services.
  • Relies on the n8n environment to provide credentials securely.
  • No additional external dependencies beyond the provided Ajax API and its authentication.

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials can cause authentication failures.
    • Incorrect companyId or hubId values may lead to errors or no effect.
    • Network connectivity issues between n8n and the Ajax API endpoint can cause timeouts or request failures.
  • Error Messages:

    • Authentication errors usually indicate invalid or missing API keys; verify credentials.
    • Validation errors may occur if required properties are missing or malformed; ensure all required fields are correctly filled.
    • API response errors should be checked for detailed messages from the Ajax service to guide corrective actions.

Links and References

Discussion