CIPP (CyberDrain Improved Partner Portal)

A step-by-step guide to getting started with the CIPP Integration with Gradient MSP.

billingalerts

Special Integration: The CIPP integration is a Custom Integration that requires authentication within CIPP in order to establish a successful connection each time you wish to push counts.

While we offer the option to use Custom integrations, please note that our ability to troubleshoot and provide support for them is limited.

If you have followed the instructions provided in this guide and require further assistance, we recommend visiting out the CIPP GitHub page located here: https://github.com/KelvinTegelaar/CIPP/

You can submit bugs and feature requests here: https://github.com/KelvinTegelaar/CIPP/issues/new/choose

Connecting the CIPP Integration 

  1. Generate Vendor API Keys 
  2. Connect the integration. 
  3. Map Accounts and Services  
  4. Reconcile  

Disconnecting the CIPP Integration 

  1. Disconnect the Integration 

Step 1: Generate Vendor API Keys 

  1. Login to Synthesize, Navigate to Integrations, and click on Custom
  2. Select the modules you want to integrate
  3. Assign a Name and Description of Cyberdrain or CIPP to the custom integration.
  4. Agree to the Terms and Conditions
  5. Generate API Keys
  6. Note the details for use within Cyberdrain.  

Step 2: Connect the Integration 

  1. Login to CIPP and navigate to the Extensions tab. 
  2. Enter the Gradient Vendor and Partner API Keys. Set the checkbox for "Enable Integration".
  3. Click on "Test Connection" to see if you've entered the keys correctly.
  4. After entering the keys, you can force the first sync.
  5. Navigate back to Synthesize and click the Status Refresh button for the CIPP integration.
  6. Press Next to complete the service and account mapping. 

If the integration is not connecting, but you have followed these steps - please try this: 

For Step 2, part 2 Enter the Gradient Vendor and Partner API Keys - The newest instance of CIPP can not accept both at the same time. 
  1. Paste the Partner API Key first and hit Set Extension Settings
  2. Refresh the Page
  3. Paste the Vendor API Key second and hit Set Extension Settings

Step 3: Map Accounts and Services 

  1. Map your accounts by dragging the card from Synthesize on the left to CIPP on the right. When complete, press Next.   
    1. We have auto-mapped any that are exact matches. The remaining can be searched by pressing the filter button or typing in the Synthesize search bar.  
  2. Map your services by dragging the card from Synthesize on the left to CIPP on the right. When complete, press Next.   
    1. Services can be searched by pressing the filter button or typing in the Synthesize search bar.  
  3. Review and Press Finish 
  4. Navigate back to CIPP and click Force Sync to import usage

See tips and tricks for mapping in the tool: How to map within Synthesize  

A pop-up will inform you that the setup is complete and that the syncing of usage can take a few seconds to several minutes.  


Step 4: Reconcile 

  1. You are now ready to start reconciling.   
  2. To view only that vendor’s results, you can select the filter option and choose the vendor to display the imported values and reconcile.  

Disconnecting the Integration 

  1. Loginto Synthesize and navigate to the Integrations tab. 
  2. Filter to Connected Integrations 
  3. Select the Custom Integration card and click Configure.  
  4. Press Disconnect and Confirm. 
  5. Navigate to the Vendor account and turn off your API keys.  

Disconnecting this integration will remove the authentication settings and all account and service mapping. You can reconnect this integration, but you must also remap your account and services. 

Troubleshooting steps

Stuck in pending: 


If you've configured the integration but haven't seen usage syncing or if the integration status remains "pending," you may need to follow these troubleshooting steps:

Reconfigure Integration Keys:

    1. Start by pasting the Partner API Key and clicking Set Extension Settings in CIPP.

    2. Refresh the page in Synthesize.

    3. Next, paste the Vendor API Key and hit Set Extension Settings in CIPP.

Proceed with authentication, and it should complete. 

Accounts appear Duplicated: 

Sometimes it may appear that the same account is showing twice. This can happen if, for some reason, your default domain name is changed in CIPP.  We do have a request in to have this corrected. https://github.com/KelvinTegelaar/CIPP/issues/1808