Sherweb icon

Sherweb

Interact with Sherweb API

Overview

The node integrates with the Sherweb API to perform various operations related to Sherweb services. Specifically, for the Tracking resource and the TrackRequest operation, it allows users to query the status or details of a tracking request by providing a tracking ID. This is useful in scenarios where you need to monitor or retrieve information about specific requests or transactions processed through Sherweb.

Practical examples include:

  • Checking the progress or outcome of a provisioning or service request.
  • Retrieving detailed tracking information for auditing or customer support purposes.

Properties

Name Meaning
API Type Selects which Sherweb API to use: either the "Service Provider API" or the "Distributor API".
Tracking ID The unique identifier of the tracking request you want to query.

Output

The node outputs JSON data representing the tracking information retrieved from the Sherweb API for the given tracking ID. This typically includes status, timestamps, and other metadata related to the tracking request.

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

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials.
  • Needs a subscription key credential to be set in the node's configuration.
  • Connects to the Sherweb API endpoint at https://api.sherweb.com.

Troubleshooting

  • Common issues:

    • Invalid or missing tracking ID will cause the API call to fail.
    • Incorrect API type selection may lead to unexpected errors or no data returned.
    • Missing or invalid API credentials (OAuth2 token or subscription key) will result in authentication errors.
  • Error messages:

    • Authentication errors usually indicate problems with the API credentials; verify that the OAuth2 token and subscription key are correctly configured.
    • "Tracking ID not found" or similar errors mean the provided tracking ID does not exist or is incorrect.
    • Network or timeout errors suggest connectivity issues with the Sherweb API endpoint.

Links and References

Discussion