Rest Accounting

Interact with Rest Accounting API
Join our community

Actions13

Overview

This node interacts with a RESTful accounting API to retrieve health status information about the API service. Specifically, the Health - Get operation performs a simple GET request to the /health endpoint of the API. This is useful for checking if the accounting API service is operational and responsive before performing other operations.

Common scenarios include:

  • Verifying API availability as part of an automated workflow.
  • Monitoring the health status of the accounting system.
  • Triggering alerts or fallback logic if the API is down.

Example: Before syncing financial data, you might use this node to confirm the accounting API is up and running.

Properties

Name Meaning
Query Parameters (Not used in Health - Get operation)

For the Health - Get operation, no additional input properties are required beyond selecting the resource "Health" and operation "Get".

Output

The output is a JSON object representing the response from the /health endpoint of the accounting API. The exact structure depends on the API but typically includes fields indicating service status, uptime, version, or other health metrics.

Output example (hypothetical):

{
  "status": "ok",
  "uptime": 123456,
  "version": "1.2.3"
}

No binary data is returned by this operation.

Dependencies

  • Requires an API key credential to authenticate requests to the accounting API.
  • The base URL of the accounting API must be configured in the credentials.
  • The node uses HTTP GET requests with Content-Type: application/json and an x-api-key header for authentication.

Troubleshooting

  • API Key Missing or Invalid: If the API key credential is not set or invalid, the node will throw an error indicating authentication failure. Ensure the API key is correctly configured.
  • Network Issues: Connection errors or timeouts may occur if the API endpoint is unreachable. Verify network connectivity and the base URL configuration.
  • Unexpected Response Format: If the API changes its /health response format, downstream nodes expecting certain fields may fail. Check the API documentation for updates.
  • Error Message: "Request failed" indicates a problem with the HTTP request; inspect the detailed message for specifics.

Links and References

Discussion