AjaxInstall

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). Specifically, for the Resource "Network" and Operation "Update GSM Sim Card Settings For Company," it updates the GSM SIM card settings associated with a particular company and hub. This operation is useful in scenarios where a company manages multiple hubs or devices requiring updated cellular network configurations such as APN, username, and password for their SIM cards.

Practical examples include:

• Updating the APN settings for a company's IoT devices connected via GSM.
• Changing authentication credentials for SIM cards used in remote hubs.
• Managing SIM card configurations remotely without manual intervention on each device.

Properties

Output

The node outputs JSON data representing the result of the update operation performed on the GSM SIM card settings. The exact structure depends on the Ajax API response but typically includes confirmation of the update status, any error messages if applicable, and possibly the updated configuration details.

If binary data were involved (not indicated here), it would represent files or media related to the operation, but this node focuses on JSON responses only.

Dependencies

• Requires an API key credential for authenticating with the Ajax API.
• Depends on the external Ajax API service being available and reachable.
• Uses internal helper classes for HTTP communication, state management, and operation resolution.
• No environment variables are explicitly required beyond the API credential.

Troubleshooting

• Common Issues:

  • Invalid or missing API credentials will cause authentication failures.
  • Providing incorrect companyId or hubId may result in not found errors.
  • Exceeding maximum lengths for apn, username, or password fields can cause validation errors.
  • Using an invalid simCardIndex (other than 1 or 2) may lead to unexpected behavior or errors.

• Error Messages:

  • Authentication errors: Check that the API key credential is correctly configured and valid.
  • Validation errors: Ensure all required fields are provided and respect length constraints.
  • Not found errors: Verify that the specified company and hub IDs exist in the system.
  • Network or timeout errors: Confirm network connectivity and API availability.

Links and References

• Ajax API Documentation (general reference for the Ajax platform)
• n8n documentation on Creating Custom Nodes
• General info on GSM SIM card settings and APN configuration: Wikipedia APN