> ## Documentation Index
> Fetch the complete documentation index at: https://docs.msportal.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure Sherweb Integration

> Connect your Sherweb distributor account to MSPortal.ai to sync customers, subscriptions, and per-customer product catalogs

This guide walks you through connecting your Sherweb distributor account to MSPortal.ai using our streamlined setup wizard. The Sherweb integration is currently in Beta.

## Overview

Sherweb is a cloud solutions distributor for MSPs. By integrating Sherweb with MSPortal.ai, you can:

* View every client's Sherweb subscriptions alongside the rest of their data
* Sync each customer's offer catalog, including pricing, from Sherweb
* Power the Storefront with a curated, client-facing product catalog
* Keep subscription and catalog data refreshed automatically every day

## Prerequisites

* Active Sherweb partner account with access to the Sherweb Partner Portal (cumulus.sherweb.com)
* MSPortal.ai account with integration management permissions
* Sherweb API credentials: a Client ID, Client Secret, and Subscription Key

## Part 1: Generate Sherweb API Credentials

Before connecting to MSPortal.ai, you need API credentials from the Sherweb Partner Portal.

<Steps>
  <Step title="Log into the Sherweb Partner Portal">
    Access the Sherweb Partner Portal at [cumulus.sherweb.com](https://cumulus.sherweb.com).
  </Step>

  <Step title="Navigate to API Management">
    Go to **Security > APIs** in the Partner Portal.
  </Step>

  <Step title="Create Service Provider API Credentials">
    Create credentials for the **Service Provider API**. Sherweb issues three values that MSPortal needs:

    | Value                | Purpose                                                                                  |
    | -------------------- | ---------------------------------------------------------------------------------------- |
    | **Client ID**        | Identifies your API client                                                               |
    | **Client Secret**    | Authenticates your API client                                                            |
    | **Subscription Key** | The `Ocp-Apim-Subscription-Key` value that authorizes access to the Service Provider API |
  </Step>

  <Step title="Copy All Three Values">
    Copy the Client ID, Client Secret, and Subscription Key.

    <Warning>
      **Store the Client Secret securely.** You may not be able to view it again after leaving the page. If you lose it, generate new credentials in the Partner Portal.
    </Warning>
  </Step>
</Steps>

***

## Part 2: MSPortal Setup Wizard

MSPortal.ai provides a guided 3-step wizard to connect and configure your Sherweb integration: **Connect**, **Map Customers**, and **Complete**.

### Starting the Wizard

<Steps>
  <Step title="Navigate to Integrations">
    In MSPortal.ai, go to **Settings > Integrations**.
  </Step>

  <Step title="Find Sherweb">
    Locate the **Sherweb** integration card in the list of available integrations.
  </Step>

  <Step title="Start Setup">
    Click **Setup** to launch the setup wizard.
  </Step>
</Steps>

***

### Step 1: Connect

Enter your Sherweb API credentials to establish the connection. All three values are required.

<Steps>
  <Step title="Enter Credentials">
    Fill in the three fields:

    * **Client ID**
    * **Client Secret**
    * **Subscription Key**

    <Note>
      Your Sherweb credentials are stored securely using Supabase Vault encryption. They are never exposed in logs or API responses.
    </Note>
  </Step>

  <Step title="Test Connection">
    Click **Test connection** to verify your credentials.

    If the test fails:

    * Verify you copied each value in full, without extra spaces
    * Confirm the values came from **Security > APIs** in the Sherweb Partner Portal
    * Ensure the credentials have not been revoked
  </Step>

  <Step title="Save and Connect">
    Click **Save and connect** to create the integration.

    MSPortal immediately starts fetching your Sherweb customer list in the background, so it is ready for the next step.
  </Step>
</Steps>

***

### Step 2: Map Customers

Map Sherweb customers to your MSPortal companies. This determines which data syncs to which company.

<Steps>
  <Step title="Wait for Customers to Appear">
    The customer list fills in automatically as the initial sync completes; the page checks for new customers every few seconds. If the list stays empty, click **Sync Customers** to start the sync again.

    <Info>
      The initial customer sync usually finishes within a couple of minutes.
    </Info>
  </Step>

  <Step title="Use Quick Match">
    Click **Quick Match** to automatically match Sherweb customers to MSPortal companies based on name similarity. Review the suggested matches and apply the ones that look right.
  </Step>

  <Step title="Manual Mapping">
    For customers that were not automatically matched:

    1. Find the customer in the list
    2. Click the **Select company** dropdown in the "Mapped" column
    3. Search for and select the correct MSPortal company
  </Step>

  <Step title="Create New Companies">
    If a Sherweb customer does not have a corresponding MSPortal company, use **Create new company** to add one. New companies are automatically mapped to their Sherweb customers.
  </Step>

  <Step title="Apply and Proceed">
    Click **Import Selected** to apply your pending mappings, then click **Next**. Any remaining pending mappings are saved automatically when you advance.

    <Warning>
      You must map at least one customer before proceeding. Subscriptions and catalog data are only synced for mapped customers.
    </Warning>
  </Step>
</Steps>

<Note>
  When you leave the Map Customers step, MSPortal automatically starts a sync so newly mapped customers get their subscriptions and catalog data right away.
</Note>

***

### Step 3: Complete

Confirm the integration and run your first full sync.

<Steps>
  <Step title="Run a Full Sync">
    Click **Run full sync** to pull your Sherweb customers, then the subscriptions and offer catalog for every mapped customer.

    The sync runs in the background. You can click **View company mapping** to review your customer-to-company links while it runs.
  </Step>

  <Step title="Complete Setup">
    Click **Complete setup** to finish the wizard and return to the Integrations page.
  </Step>
</Steps>

***

## What Gets Synced

The Sherweb integration syncs the following data:

### Customers

Every customer under your Sherweb account, ready to be mapped to MSPortal companies.

### Subscriptions

Subscription details and pricing for each **mapped** customer, including quantities, status, and billing information. Subscriptions appear in the [Storefront](/user-guides/storefront/index) under Subscriptions.

### Catalog Items

Each mapped customer's offer catalog from Sherweb, including product names, SKUs, and pricing. You control which catalog items clients can see: go to **Settings > Storefront** to mark Sherweb catalog items as **Visible** or **Featured**.

<Note>
  Sherweb subscriptions and catalogs are customer-scoped, so only data for customers mapped to an MSPortal company is stored.
</Note>

***

## Synchronization Schedule

After initial setup, data syncs automatically:

| Data Type     | Sync Frequency     |
| ------------- | ------------------ |
| Customers     | Daily at 07:00 UTC |
| Subscriptions | Daily at 07:00 UTC |
| Catalog Items | Daily at 07:00 UTC |

The daily sync runs customers first, then subscriptions, then catalogs, so subscription and catalog data always reflects your latest customer mappings.

<Note>
  You can trigger a manual sync at any time: open the Sherweb wizard from **Settings > Integrations** and click **Run full sync** on the Complete step, or use the resync action on the integration card.
</Note>

***

## Managing Your Integration

After setup, manage your integration from **Settings > Integrations**:

| Action              | Description                                                          |
| ------------------- | -------------------------------------------------------------------- |
| **Configure**       | Re-open the wizard to rotate credentials or adjust customer mappings |
| **Test connection** | Verify your saved credentials are still valid                        |
| **Resync**          | Trigger a full data refresh                                          |
| **Delete**          | Remove the integration (available in the wizard footer)              |

### Rotating Your Credentials

If you need to update your Sherweb API credentials:

<Steps>
  <Step title="Open Integration Settings">
    Go to **Settings > Integrations** and open the Sherweb wizard.
  </Step>

  <Step title="Enter New Values">
    On the Connect step, enter only the values you want to change. Leave a field blank to keep its current value.
  </Step>

  <Step title="Test and Update">
    Click **Test connection** to verify, then click **Update credentials** to save.
  </Step>
</Steps>

### Managing Customer Mappings

Manage your Sherweb customer-to-company mappings at any time:

* Re-open the wizard and go to the **Map Customers** step, or
* Go to **Settings > Integrations > Company Mapping**

### Deleting the Integration

Click **Delete** in the wizard footer. This removes the integration, your stored credentials, and previously synced customer records. You can reconnect at any time.

***

## Troubleshooting

| Issue                                | Solution                                                                                                   |
| ------------------------------------ | ---------------------------------------------------------------------------------------------------------- |
| Connection test fails                | Verify all three values (Client ID, Client Secret, Subscription Key) are correct and copied in full        |
| No customers appear on the Map step  | The initial sync can take a few minutes; the list refreshes automatically. Click "Sync Customers" to retry |
| Subscriptions or catalog missing     | Only mapped customers sync; map the customer to a company, then run a full sync                            |
| Catalog items not visible to clients | Check item visibility under Settings > Storefront                                                          |
| Stale data                           | Run a full sync from the wizard's Complete step, or wait for the daily 07:00 UTC sync                      |

***

## Security & Privacy

* **Credential Storage**: Your Sherweb Client ID, Client Secret, and Subscription Key are encrypted using Supabase Vault and never exposed in logs or responses
* **Data Isolation**: All synced data is tenant-isolated and only visible to your organization
* **Read-Only Access**: MSPortal only reads data from Sherweb; it never modifies your Sherweb subscriptions or places orders

***

## Next Steps

After setting up the Sherweb integration:

<CardGroup cols={2}>
  <Card title="Set Up the Storefront" icon="store" href="/user-guides/storefront/index">
    Curate the client-facing catalog and manage subscriptions
  </Card>

  <Card title="Import Companies" icon="building" href="/user-guides/integrations/import-companies">
    Learn more about mapping integration customers to companies
  </Card>

  <Card title="Sync Schedules" icon="clock" href="/user-guides/integrations/sync-schedules">
    See when each integration refreshes its data
  </Card>

  <Card title="Other Integrations" icon="plug" href="/user-guides/integrations/index">
    Explore additional integration options
  </Card>
</CardGroup>

## Need Help?

For assistance with the Sherweb integration, contact [support@msportal.ai](mailto:support@msportal.ai).