Sherweb icon

Sherweb

Interact with Sherweb API

Overview

The node integrates with the Sherweb API, allowing users to interact with various Sherweb resources. Specifically, for the "Platform" resource and the "Get Platforms" operation, it retrieves platform data from Sherweb's APIs. This is useful in scenarios where you need to fetch and process platform information either from the Service Provider API or the Distributor API.

Practical examples include:

  • Synchronizing platform data into your internal systems.
  • Extracting platform details for reporting or auditing purposes.
  • Automating workflows that depend on up-to-date platform information from Sherweb.

Properties

Name Meaning
API Type Selects which Sherweb API to use: "Service Provider API" or "Distributor API".
Extracted Platforms A JSON array representing platforms extracted from the API response.
Extract Platforms Boolean flag indicating whether to extract platforms from the API response (true/false).

Output

The node outputs JSON data containing platform information retrieved from Sherweb. When "Extract Platforms" is enabled, the output includes an array of platform objects under the extractedPlatforms field. Each platform object corresponds to a platform entity as defined by Sherweb's API.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials.
  • Needs a subscription key credential to be set in the node configuration.
  • The base URL for API requests is https://api.sherweb.com.
  • The node depends on Sherweb's REST API endpoints for platform data.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials can cause authentication failures.
    • Incorrect selection of API Type may lead to unexpected or empty responses.
    • If "Extract Platforms" is enabled but the response format changes, extraction might fail.
  • Error messages:

    • Authentication errors typically indicate invalid or expired tokens; re-authenticate or update credentials.
    • HTTP 4xx or 5xx errors suggest issues with request parameters or server availability; verify inputs and retry later.
    • JSON parsing errors may occur if the API response structure changes; check API documentation for updates.

Links and References

Discussion