Nerdio Manager Distributor API - Use Cases

This article provides an overview of the integration points between Nerdio Manager and a distributor’s portal.

MSP Purchases Nerdio Manager in the Distributor's Portal

1. MSP goes to distributor's portal and locates the listing for Nerdio Manager.

2. MSP selects Buy.

3. MSP is prompted to enter the Subscription ID (or select from drop-down list) of Azure subscription where they will install Nerdio Manager or have already installed Nerdio Manager.

4. Distributor's portal makes a /register API call to Nerdio Manager’s licensing system (known as the Mothership) with the Azure Subscription ID.

5. Mothership API checks if an install with that Subscription ID already exists.

6. If API finds a matching install:

   • And if there is no other distributor tied to the install, then the distributor is assigned to the install. Returns Install ID(s) in API response. Mothership sends a confirmation email to MSP (optional – only if flag in API tells it to) and internally to Nerdio support staff.

     Note: MSP could have installed Nerdio Manager multiple times in the same Azure subscription. Most MSPs won’t, but to account for the scenario, API may return multiple Install IDs. Typically, it returns one Install ID.

   • And if there is another distributor tied to the install, then API response indicates Distributor must reach out to Nerdio support. Mothership notifies Nerdio support staff.

   • And if distributor is already tied to the install, then the API response indicates as such. Returns Install ID in API response. Mothership sends confirmation email to MSP (optional) and internally to Nerdio support staff.

7. If API does not find a matching install

   • API creates an empty shell of an install record in Mothership. Returns Install ID in API response. Mothership sends confirmation email internally to Nerdio support staff.

   • When MSP installs Nerdio Manager, upon submission of the Registration form, the install process checks if a shell of an install record already exists for Azure Subscription ID, and if so ties to the install.

MSP Cancels Purchase of Nerdio Manager in the Distributor's Portal

1. MSP goes to distributor's portal and locates the listing for Nerdio Manager.

2. MSP selects Cancel purchase.

3. MSP is prompted to enter the Azure Subscription ID (or select from drop-down list).

4. Distributor portal makes a /cancel API call to Nerdio Manager Mothership with the Azure Subscription ID.

5. Mothership API checks if an install with that Subscription ID already exists.

6. If API finds a matching install:

   • If distributor is not tied to the install, then API response indicates distributor must reach out to Nerdio support.

   • If distributor is tied to the install, then the distributor assignment is removed, and the install is suspended. Mothership sends a confirmation email to MSP (optional) and internally to Nerdio support staff.

   • If API does not find a matching install then API response indicates as such.

Distributor Suspends a Nerdio Manager Install

1. Distributor's portal makes a /suspend API call to Mothership with the Azure Subscription ID.

2. If API finds a matching install

   • If distributor is not tied to the install, then API response indicates distributor must reach out to Nerdio support.

   • If distributor is tied to the install, then the install is suspended. Mothership sends a confirmation email internally to Nerdio support staff.

3. If API does not find a matching install, then API response indicates as such.

Distributor Reactivates a Suspended Nerdio Manager Install

1. Distributor's portal makes a /reactivate API call to Mothership with the Azure Subscription ID.

2. If API finds a matching install

   • If distributor is not tied to the install, then API response indicate distributor must reach out to Nerdio support.

   • If distributor is tied to the install, then the install is Activated. Mothership sends a confirmation email to MSP (optional) and internally to Nerdio support staff.

3. If API does not find a matching install, then API response indicates as such.

Distributor Collects Usage (Billing) Information

1. Distributor's portal makes a /usage API call to Mothership.

2. Returns usage information for specified date range in API response.