Sherweb icon

Sherweb

Interact with Sherweb API

Actions19

Overview

This node interacts with the Sherweb API to retrieve subscription-related data. Specifically, for the "Subscription" resource and the "Get Customer Subscription Meters" operation, it fetches meter information associated with a customer's subscription on a given platform. This is useful in scenarios where you need to monitor or report on usage metrics or metered services tied to customer subscriptions.

Practical examples include:

  • Generating reports on customer subscription usage.
  • Integrating subscription meter data into billing or analytics workflows.
  • Automating alerts based on subscription meter thresholds.

Properties

Name Meaning
API Type Selects which Sherweb API to use: "Service Provider API" or "Distributor API".
Customer ID The unique identifier of the customer whose subscription meters are being retrieved.
Platform ID The unique identifier of the platform associated with the customer's subscription meters.

Output

The node outputs JSON data containing the subscription meters related to the specified customer and platform. The exact structure depends on the Sherweb API response but typically includes details such as meter names, usage quantities, limits, and possibly timestamps.

If binary data were involved (not indicated here), it would represent files or attachments related to the subscription meters, but this node focuses on JSON data output.

Dependencies

  • Requires an API key credential for authentication with Sherweb's API.
  • Uses OAuth2-based authentication configured in n8n credentials.
  • Connects to the Sherweb API endpoint at https://api.sherweb.com.
  • The user must have valid access rights to query customer subscription meters via the Sherweb API.

Troubleshooting

  • Invalid Customer ID or Platform ID: Ensure that the provided IDs exist and are correctly formatted; otherwise, the API may return errors or empty results.
  • Authentication Errors: Verify that the API key credential is correctly set up and has not expired.
  • API Rate Limits: If many requests are made in a short time, the API might throttle requests; implement retry logic or reduce request frequency.
  • Network Issues: Confirm network connectivity to api.sherweb.com and that no firewall blocks the requests.

Common error messages might include unauthorized access, resource not found, or bad request due to missing parameters. Resolving these usually involves checking credentials, input parameters, and API permissions.

Links and References

Discussion