Submit a request

Nerdio Help Center

NMM Distributor API - use cases


Applies to: Nerdio Manager for MSP (NMM) Distributors

Available in v1.1.0+


This KB provides an overview of the integration points between Nerdio for MSP (NMM) and a distributor’s portal.

MSP purchases NMM in distributor's portal

  1. MSP goes to distributor's portal and locates the listing for NMM
  2. MSP clicks "Buy" button
  3. MSP is prompted to enter Subscription ID (or select from drop-down) of Azure subscription where they will install NMM or have already installed NMM
  4. Distributor's portal makes /register API call to NMM’s licensing system (known as the Mothership) with Azure Subscription ID
  5. Mothership API checks if an Install with that Subscription ID already exists
  6. If API finds a matching Install
    1. And if there is no other distributor tied to the Install, then the distributor is assigned to Install. Returns Install ID(s) in API response. Mothership will send confirmation email to MSP (optional – only if flag in API tells it to) and internally to Nerdio support staff. Note that MSP could have installed NMM 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 will return one Install ID.
    2. And if there is another distributor tied to the Install, then API response will indicate Distributor must reach out to Nerdio support. Mothership will notify Nerdio support staff.
    3. And if distributor is already tied to the Install, then the API response will indicate as such. Returns Install ID in API response. Mothership will send confirmation email to MSP (optional) and internally to Nerdio support staff.
  7. If API does not find a matching Install
    1. API will create an empty shell of Install record in Mothership. Returns Install ID in API response. Mothership will send confirmation email internally to Nerdio support staff.
    2. When MSP installs NMM, upon submission of the Registration form, the install process will check if a shell of an Install record already exists for Azure Subscription ID, and if so tie to Install.

 

MSP cancels purchase of NMM in distributor's portal

  1. MSP goes to distributor's portal and locates the listing for NMM
  2. MSP clicks "Cancel purchase" button
  3. MSP is prompted to enter Azure Subscription ID (or select from drop-down)
  4. Distributor portal makes /cancel API call to NMM Mothership with Azure Subscription ID
  5. Mothership API checks if an Install with that Subscription ID already exists
  6. If API finds a matching Install
    1. And if distributor is not tied to the Install, then API response will indicate distributor must reach out to Nerdio support
    2. And if distributor is tied to the Install, then the distributor assignment is removed, and Install is suspended. Mothership will send confirmation email to MSP (optional) and internally to Nerdio support staff.
    3. If API does not find a matching Install then API response will indicate as such

 

Distributor suspends an NMM Install

  1. Distributor's portal makes /suspend API call to Mothership with Azure Subscription ID
  2. If API finds a matching Install
    1. And if distributor is not tied to the Install, then API response will indicate distributor must reach out to Nerdio support
    2. And if distributor is tied to the Install, then Install is suspended. Mothership will send confirmation email internally to Nerdio support staff.
  3. If API does not find a matching Install, then API response will indicate as such

 

Distributor reactivates a suspended NMM install

  1. Distributor's portal makes /reactivate API call to Mothership with Azure Subscription ID
  2. If API finds a matching Install
    1. And if distributor is not tied to the Install, then API response will indicate distributor must reach out to Nerdio support
    2. And if distributor is tied to the Install, then Install is Activated. Mothership will send confirmation email to MSP (optional) and internally to Nerdio support staff.
  3. If API does not find a matching Install, then API response will indicate as such.

 

Distributor collects usage (billing) information

  1. Distributor's portal makes /usage API call to Mothership with Azure Subscription ID
  2. Return usage information for specified date range in API response
Was this article helpful?
0 out of 0 found this helpful

Comments

Please sign in to leave a comment.