Sherweb icon

Sherweb

Interact with Sherweb API

Actions19

Overview

This node interacts with the Sherweb API to retrieve configurations related to customer platforms. Specifically, the "Get Customer Platforms Configurations" operation fetches configuration details for a given customer's platform setup. This is useful in scenarios where you need to programmatically access or audit the platform configurations assigned to a customer, such as integrating Sherweb platform data into your internal systems, automating reporting, or synchronizing platform settings.

Practical examples include:

  • Automatically retrieving and displaying a customer's platform configurations in a custom dashboard.
  • Using the configurations to validate or update other system components based on the customer's platform setup.
  • Integrating with billing or provisioning workflows that depend on platform configuration details.

Properties

Name Meaning
API Type Selects which Sherweb API to use: either "Service Provider API" or "Distributor API".
Customer ID The unique identifier of the customer whose platform configurations are being retrieved.

Output

The node outputs JSON data containing the customer platform configurations fetched from the Sherweb API. The structure typically includes details about the platforms associated with the specified customer, their settings, and any relevant metadata.

If the node supports binary data output (not indicated here), it would represent files or attachments related to the platform configurations, but this is not evident from the provided code.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate requests to the Sherweb API.
  • Uses the base URL https://api.sherweb.com for all API calls.
  • Requires a subscription key header (Ocp-Apim-Subscription-Key) provided via credentials.
  • The node depends on the Sherweb API being accessible and the authenticated user having permissions to read customer platform configurations.

Troubleshooting

  • Common Issues:
    • Invalid or missing API credentials can cause authentication failures.
    • Providing an incorrect or non-existent Customer ID will result in errors or empty responses.
    • Network connectivity issues may prevent successful API calls.
  • Error Messages:
    • Authentication errors typically indicate invalid or expired API tokens; re-authenticate or update credentials.
    • "Customer not found" or similar messages suggest verifying the Customer ID input.
    • Rate limiting or quota exceeded errors require checking API usage limits or contacting Sherweb support.

Links and References

Discussion