Sherweb icon

Sherweb

Interact with Sherweb API

Actions19

Overview

This node integrates with the Sherweb API to manage customer platform configurations. Specifically, the "Configure Customer Platforms" operation allows users to set or update configuration parameters for various platforms associated with a given customer. This is useful in scenarios where customers use multiple platforms that require specific settings or credentials to operate correctly.

Practical examples include:

  • Automating the setup of platform integrations for new customers.
  • Updating platform-specific parameters such as API keys, endpoints, or feature toggles.
  • Managing multiple platform configurations in bulk via JSON input.

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 configurations are being managed.
Platform Configurations A JSON array specifying one or more platform configurations. Each configuration includes a platform ID and an array of required parameters (identifier-value pairs) to be set for that platform.

Example structure for Platform Configurations:

[
  {
    "platformId": "string",
    "requiredParameters": [
      {
        "identifier": "string",
        "value": "string"
      }
    ]
  }
]

Output

The node outputs JSON data representing the result of the platform configuration request. This typically includes confirmation of the updated configurations or any relevant response data from the Sherweb API.

If the node supports binary data output, it would represent files or attachments related to the platform configurations, but based on the provided code and properties, this node primarily deals with JSON data.

Dependencies

  • Requires an API authentication token configured in n8n credentials to access the Sherweb API.
  • The node uses the base URL https://api.sherweb.com for API requests.
  • Proper subscription key and OAuth2 credentials must be set up in n8n to authenticate requests.

Troubleshooting

  • Invalid Customer ID: If the customer ID is incorrect or does not exist, the API will likely return an error. Verify the customer ID before running the node.
  • Malformed Platform Configurations JSON: Ensure the JSON array for platform configurations is well-formed and matches the expected structure; otherwise, the API may reject the request.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Confirm that the API key and OAuth2 tokens are correctly configured.
  • API Type Mismatch: Selecting the wrong API type (Service Provider vs Distributor) may lead to unsupported operations or errors. Choose the correct API type based on your account and intended operation.

Links and References

Discussion