Getting Started

This page will help you get started with Gradient's API. You'll be up and running in a jiffy!

πŸ‘

Interested in using our API?

Reach out to our Technology Alliances team.

Purpose of Gradient API

The purpose of the Gradient API is to allow vendorsvendors - Vendor, represents the vendor that is integrating with Gradient MSP to connect to Gradient Billable and automatically import the license count of a serviceservice - Service, represents the Services, SKU's, Products, or Items that vendor provides to their partners for our partnerspartners - Partner, represents the MSP clientsclients - Client represents the MSP's customers. This allows our partners the ability to easily perform their billing reconciliation.

The Vendor will need to create and manage the services that they offer. Once the services have been created and a partner connects with the integration, the client mapping will take place by the vendor.

Before Vendor Integration

Before the vendor integration is configured, partners will only see the information that is pulled directly from their PSA.

After Vendor Integration

After the vendor integration has been configured, partners will be able to see the current usage from the PSA along with the usage from their vendor directly. This allows the partner to reconcile their billing with the click of a button.

🚧

Before proceeding, please view the Use Case and User Flow Diagrams.

Prerequisites

  • JSON File - https://app.usegradient.com/api-docs-json
  • API Key - This is a unique key for each vendor. If you do not have an API Key, please reach out to our Technology Alliances team.
  • Service ID - This represents the unique identifier for each Service that the Vendor will create and manage
  • Partner API Key - When a partner is ready to use your integration, they will need to insert the Partner API Key. This allows us to know which Vendor, and which Partner we're associating

Authorization

In order to authorize your connection with Gradient, we require a GRADIENT-TOKEN.

Visit the GRADIENT-TOKEN Generation Recipe for guidance on setting up your GRADIENT-TOKEN.

Need Assistance?

Contact Gradient Support


What’s Next

Now that you've created your GRADIENT-TOKEN, we recommend you set up your vendor services.

Did this page help you?