Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

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 "Send Get Balance Request For Company," it sends a request to retrieve the balance information associated with a particular company within the network. This operation is useful in scenarios where you need to monitor or audit the financial or credit status of companies managed through the Ajax system.

Practical examples include:

  • Automatically checking the balance of a company before performing further operations.
  • Integrating balance checks into workflows that manage company accounts or billing.
  • Triggering alerts or actions based on low balance thresholds.

Properties

Name Meaning
Company Id The unique identifier of the company whose balance is being requested.
Hub Id The identifier of the hub associated with the company; required to scope the request.
Additional Fields Optional extra parameters; currently supports:
- Sim Card Index Numeric value selecting one of the SIM cards (1 or 2) to specify which card's balance to query.

Output

The node outputs JSON data containing the response from the Ajax API regarding the company's balance. The exact structure depends on the API response but typically includes fields such as current balance amount, currency, and possibly details about the SIM card if specified.

If the node supports binary data output, it would represent any binary content returned by the API, but based on the provided code and context, the primary output is JSON-formatted balance information.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the HttpClient class for making HTTP requests.
  • Uses internal modules for state management and operation resolution/execution.
  • The node must be configured with valid credentials and appropriate permissions to access the Ajax API.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key credential is correctly set up and has the necessary permissions.
  • Invalid Company Id or Hub Id: Verify that the provided identifiers are correct and exist in the Ajax system.
  • Sim Card Index errors: If specifying the simCardIndex, use only allowed values (1 or 2); otherwise, the request may fail or return incorrect data.
  • API connectivity issues: Network problems or incorrect endpoint configurations can cause failures; check network access and API availability.
  • Unexpected API responses: If the API changes or returns errors, review the error messages and update the node or credentials accordingly.

Links and References


Note: The summary is based solely on static analysis of the provided source code and property definitions without runtime execution or external API inspection.

Discussion