Skip to content

Latest commit

 

History

History
110 lines (72 loc) · 9.67 KB

sherweb-integration-setup.md

File metadata and controls

110 lines (72 loc) · 9.67 KB

Sherweb integration setup

{% hint style="success" %} This Integration supports multiple instances

Check out the instructions to set up multiple instances here. {% endhint %}

What does the Sherweb integration do?

Our Sherweb integration enables seamless management of customer information, product catalogs, subscriptions, and licenses directly within the Rewst platform. This integration streamlines operations and automates ordering processes, enhancing efficiency for MSPs.

Integration use cases

  • Automate synchronization of customer data between Sherweb and Rewst.
  • Streamline product catalog updates to ensure accurate offerings.
  • Automate subscription and license management to reduce manual tasks.
  • Enhance billing processes by integrating Sherweb's billing capabilities with Rewst.

Integration prerequisites

  • An active Sherweb partner account with API access.
  • API credentials: Client ID, Client Secret, and Subscription Key from Sherweb.
  • Access to the Rewst platform with administrative privileges.

Set up the Sherweb integration

Set up steps in Sherweb

  1. Log in to your Sherweb partner account.

  2. Navigate to the Security > APIs to generate your API credentials.
    \

  3. Click Create to set up a new API client.
    \

  4. Copy the Client ID and Client Secret.

  5. Copy and save your Subscription Key, available in the same section. You’ll need this information to continue set up in Rewst.

    \

Set up steps in Rewst

  1. Log in to the Rewst platform.

  2. Navigate to Configuration > Integrations in the left side menu.

  3. In the Integrations page, search for the Sherweb integration.

  4. Click on the integration tile to launch the Configuration setup page.

  5. Under Configuration:

    1. Optionally provide a short description of the intended use of the configuration.
    2. Check Is Default on.

  6. Under Parameters:

    1. Paste the client ID copied from Sherweb into the Client ID field of the configuration form.
    2. Paste your client secret copied from Sherweb into the Client Secret field.
    3. Paste your subdomain copied from Sherweb into the Subdomain field.
    4. Click Save Configuration.

After saving your configuration, a new section called Organization Mapping will appear in your configuration page. There you'll see the following options:

  1. Suggest Values: This option will attempt to generate mappings between Rewst organizations and child organizations in this integration.
  2. Refresh Options: This will re-read the potential mapping options - for both organizations and companies in Sherweb.
  3. Save Mappings: This will apply mapping configuration changes.

Test the integration

  1. Initiate a test action within Rewst that utilizes the Sherweb integration, such as fetching the customer catalog.
  2. Verify that the data retrieved matches your Sherweb account information, confirming a successful integration.

Crates related to the Sherweb integration

Explore the following Crates in the Rewst Crate Marketplace to maximize the power of your Sherweb integration.

Microsoft User Onboarding

This automation streamlines the offboarding process for users within an organization allowing for time savings and increased efficiency.		Screenshot 2025-03-04 at 10.16.21 AM.png
Microsoft User Offboarding

This automated workflow streamlines the New User Onboarding process by guiding users through a form to collect necessary information.		Screenshot 2025-03-04 at 10.14.00 AM.png
Sync Sherweb Customer Subscriptions to Gradient Synthesize
Daily at 9AM UTC, synchronize products and usage counts from all active subscriptions in Sherweb to Gradient Synthesize		Screenshot 2025-03-04 at 10.17.35 AM.png

{% hint style="success" %} Got an idea for a new Integration? Rewst is constantly adding new integrations to our integrations page. Submit your idea or upvote existing ideas here. {% endhint %}

Sherweb actions and endpoints

{% hint style="info" %} For more on how actions work in Rewst, check out our introductory actions documentation here. {% endhint %}

Refer to Sherweb's API documentation for detailed information on available endpoints and their usage. Ensure that you have the necessary permissions and correct endpoint URLs as specified in Sherweb's API documentation when configuring these actions. To access some API endpoints, you may have to set your rebilling settings within the partner portal, or contact your account manager at Sherweb to have them enabled manually.\

Action name Description Endpoint
Create Subscriptions Amendment Amend subscription quantities for one of your customers.. POST https://api.sherweb.com/service-provider/v1/billing/subscriptions/amendments?customerId={customerId}
Get Customers Get the list of all your customers. GET https://api.sherweb.com/service-provider/v1/customers
Get Payable Charges Get your payable charges data for a specific billing period. There are three types of charges that are included in the data returned: recurring, usage, and setup. GET https://api.sherweb.com/distributor/v1/billing/payable-charges[?date]
Get Receivable Charges Get a customer's amount owed for a specific billing period. GET https://api.sherweb.com/service-provider/v1/billing/receivable-charges?customerId={customerId}[&date]
Get Subscriptions Get the list of subscriptions for one of your customers. GET https://api.sherweb.com/service-provider/v1/billing/subscriptions?customerId={customerId}
Get Subscriptions Amendment Status Get the status of a subscriptions amendment. GET https://api.sherweb.com/service-provider/v1/billing/subscriptions/amendments/{subscriptionsAmendmentId}/status