Nerdio Manager Distributor API - Getting Started

Nerdio Manager Distributor API allows distributors to register, cancel, suspend Nerdio Manager installs and retrieve usage information.

Authentication and Authorization

To get started with Nerdio Manager API:

• Sign up as a Nerdio Manager for MSP distributor.

• Contact Nerdio Manager support team to request access to the Mothership (license management portal) and API key.

• Review Swagger documentation of API endpoints.

Nerdio Manager Distributor API uses API key-based authentication. Every endpoint has a mandatory API key parameter. Include the API key provided to you in your API calls. It is important that you keep the key secure and safe. Minimize sharing of the API key with individuals in your organization.

API URL

Direct all API calls to the following URL:

https://nmm-distributor-api.nerdio.net/api-v{version.number}

Typical Integration Flow

As a distributor, generally this is how you use the APIs:

• When a partner (MSP) purchases Nerdio Manager in your portal, call the /register endpoint to register the partner's Nerdio Manager install(s) in our licensing system (Mothership).

• If a partner cancels their purchase of Nerdio Manager, call the /cancel endpoint to unregister the partner's Nerdio Manager install(s) and disallow the partner from logging in to their Nerdio Manager install(s).

• To temporarily disallow a partner from logging in to their Nerdio Manager install(s) for non-payment or similar reasons, call the /suspend endpoint. When it is time to let partner log in to their Nerdio Manager install(s) again, call the /reactivate endpoint.

• On a monthly basis, call the /usage endpoint for Nerdio Manager usage by each partner you have previously registered.

  Note: You receive a monthly invoice separately as well.

Response Codes

All API endpoints return one of these response codes:

• 200 (OK): This is the response code you receive when your API call executes successfully.

• 400 (Bad request): This response code indicates your API call has invalid parameters or invalid parameter values. For example, you supplied an incorrect version number.

• 401 (Unauthorized): This response code indicates your API key does not authorize you to retrieve the information requested.

• 422 (Unprocessable entity): This response code indicates the Azure subscription ID you specified is not valid or may not be a GUID.

• 500 (Internal Server Error): This response code indicates that the information you supplied in the parameters is incorrect. For example, you did not provide a valid GUID for the Azure Subscription ID.

• 409 (Conflict): The /register endpoint returns this response code to indicate that another distributor has already registered Nerdio Manager installs by the partner you are trying to register.