Actions19
- Customer Actions
- Customer Catalog Actions
- Customer Platform Actions
- Order Actions
- Platform Actions
- Receivable Charge Actions
- Subscription Actions
- Tracking Actions
Overview
This node integrates with the Sherweb API to retrieve detailed information about a specific customer platform. It supports querying either the Service Provider API or the Distributor API, allowing users to fetch platform details associated with a given customer and platform ID.
Typical use cases include:
- Automating retrieval of platform configurations for customers in a managed service environment.
- Integrating customer platform data into workflows for reporting or provisioning.
- Synchronizing platform details between Sherweb and other systems.
For example, a user can input a Customer ID and Platform ID to get all relevant details about that customer's platform, which can then be used to trigger further automation steps such as license management or billing updates.
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 platform details are being requested. |
| Platform ID | The unique identifier of the platform for which details are retrieved. |
Output
The node outputs JSON data containing detailed information about the specified customer platform. This typically includes platform configuration, status, and related metadata as returned by the Sherweb API.
If binary data is returned (not indicated in this code), it would represent any files or attachments related to the platform, but this node primarily deals with JSON responses.
Dependencies
- Requires an API authentication token configured via OAuth2 credentials.
- Needs a subscription key credential to be set in the node's credentials for API access.
- Connects to the Sherweb API endpoint at
https://api.sherweb.com.
Troubleshooting
- Missing or invalid credentials: Ensure that the OAuth2 API credentials and subscription key are correctly configured in n8n.
- Invalid Customer ID or Platform ID: Verify that the IDs provided exist and are correct; otherwise, the API will return errors or empty results.
- API type mismatch: Selecting the wrong API type (Service Provider vs Distributor) may result in no data or errors if the resource is not available under that API.
- Network issues: Check connectivity to
https://api.sherweb.comand ensure firewall rules allow outbound requests.
Common error messages might include authentication failures or 404 not found errors when the customer or platform does not exist. Resolving these involves verifying credentials and input parameters.
Links and References
- Sherweb API Documentation (for detailed API endpoints and data structures)
- n8n OAuth2 Credential Setup Guide (for configuring API authentication)