Sherweb icon

Sherweb

Interact with Sherweb API

Actions19

Overview

This node integrates with the Sherweb API to retrieve customer meter usage data from the Customer Platform resource. It supports querying usage information for a specific customer on a given platform, which is useful for monitoring and managing service consumption or billing metrics.

Typical use cases include:

  • Fetching detailed usage statistics for a customer to generate reports.
  • Integrating meter usage data into billing or analytics workflows.
  • Automating alerts or actions based on customer consumption patterns.

For example, a user can specify a customer ID and platform ID to get the current meter usages associated with that customer on that platform.

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 meter usages are being retrieved.
Platform ID The unique identifier of the platform associated with the customer for usage retrieval.

Output

The node outputs JSON data containing the customer meter usage details as returned by the Sherweb API. This typically includes usage metrics, timestamps, and related metadata for the specified customer and platform.

If the API returns binary data (not indicated in this code), it would be provided accordingly, but here the output is primarily structured JSON representing meter usage records.

Dependencies

  • Requires an API key credential for authentication with the Sherweb API.
  • The node uses the base URL https://api.sherweb.com for all requests.
  • The user must provide valid Customer ID and Platform ID parameters.
  • The node depends on the Sherweb OAuth2 API credentials configured within n8n.

Troubleshooting

  • Invalid Credentials: If authentication fails, verify that the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Missing Required Parameters: Ensure both Customer ID and Platform ID are provided; otherwise, the API call will fail.
  • API Rate Limits: Frequent calls may hit Sherweb API rate limits; consider adding delays or retries.
  • Incorrect API Type: Selecting the wrong API type (serviceProviderApi vs distributorApi) may result in no data or errors; confirm the correct API endpoint for your use case.

Common error messages might include authorization errors, missing parameter errors, or HTTP status codes indicating request issues. Checking the exact API response message helps diagnose these problems.

Links and References

Discussion