Shopware icon

Shopware

Shopware

Actions778

System Info Health Check → Api Info

AI-generated

Overview

This node performs a system information health check by making an API call to retrieve API information. It supports specifying the type of API response expected (either 'jsonapi' or 'json') and allows customization of request options such as batching, SSL certificate validation, proxy usage, and request timeout. This node is useful for monitoring and verifying the health and status of an API endpoint, ensuring it is responsive and returning expected data.

Use Case Examples

  1. Checking the health status of a system API by requesting its info in JSON API format.
  2. Using the node to fetch API info with custom request options like proxy and timeout to handle network configurations.

Properties

Name Meaning
Type Specifies the type of the API response expected, either 'jsonapi' or 'json'.
Request Options Collection of optional settings to customize the API request, including batching, SSL certificate validation, proxy, and timeout.

Output

JSON

  • apiInfo - The JSON response containing the API information retrieved from the system health check.

Dependencies

  • An API key credential for authenticating with the target system's API.

Troubleshooting

  • Ensure the API endpoint URL is correctly configured in the node credentials to avoid connection errors.
  • If SSL certificate validation fails and the node is set to reject unauthorized certificates, enable the 'Ignore SSL Issues' option to bypass this check (use with caution).
  • Check proxy settings if the node cannot connect to the API due to network restrictions.
  • Adjust the timeout setting if the API server is slow to respond to prevent premature request abortion.

Discussion