Microsoft Partner Center APIs: Implementation Guide

Overview

The  Microsoft Partner Center (MPC) API enhances your partner collaboration capabilities with improved features and performance. This guide provides a step-by-step roadmap to successfully implement the new API, ensuring your onboarding is smooth and efficient. By following these instructions, you'll be able to quickly leverage the advanced functionality of MPC’s new API in your WorkSpan environment.

Prerequisites

• Access to your WorkSpan Account
• Microsoft credentials with "Referral Admin" access
• Preferably, a service user account (with Referral Admin access to your MPC)

ℹ️ NOTE
It is recommended to use a Service Account instead of a Personal (user-based) Account. This is because if a person leaves the organization, their account — and consequently the stored refresh token — will become invalid, which can result in authentication failures.

Implementation Steps for New Users

If you are a new WorkSpan Co-Sell with Microsoft customer implementing the Microsoft API, there are multiple steps needed to ensure a smooth onboarding process.  The WorkSpan Professional Services team will guide you through each step of this process and ensure a seamless integration.  When you are ready to begin your implementation, follow the steps below, and then the WorkSpan Professional Services team will handle the rest.

Step 1. Navigate to Microsoft Partner Center (MPC) in WorkSpan

• Sign in as a Service User (Administrator) to the WorkSpan App.

• Click on “ (1) My Company Profile” in the top right corner. You’ll be taken to the “About” page under “My Company”. 

• Click (2) “Applications” and then click (3) Microsoft > (4) Microsoft Partner Center > (5) MPC Connection.

Step 2. Add & Save the Microsoft Username

• Click "Edit" to add the username 

• The “Edit” pop-up appears on the screen. Enter the  Microsoft username, and click "Save."

ℹ️ NOTE 
It is recommended to use a Service Account instead of a Personal (user-based) Account. This is because if a person leaves the organization, their account — and consequently the stored refresh token — will become invalid, which can result in authentication failures.

Step 3. Authorize the Connection

• Click the now-enabled "Authorize" button. You'll be redirected to the Microsoft Partner Center login.

Step 4. Log in with MPC Admin Credentials

• Use your Microsoft credentials with "Partner Center Admin" access to log in.

Step 5. Accept Permissions

• Review the permissions page and click "Accept." You will be redirected to the WorkSpan Companies Page.

ℹ️ NOTE
You will need to disable Power Automate (PA) flows and enable Integrations to complete the implementation. Please contact your system administrator or the WorkSpan support team at support.workspan.com; alternatively, email us at Support@WorkSpan.com.

Step 6. Verify Connection Status

You'll be redirected back to WorkSpan. Check the "Connection status."

• Active Status: Success!

• Inactive Status: Re-authenticate from Step 1.

Step 7. Select Organization Name 

Select the correct organization name from the "Select Organization" dropdown and click on Save:

ℹ️ NOTE 
To retrieve your exact organization name, visit the Microsoft Partner Center Account Settings Page. Under the "Company Details" section, you will find the Company name, which should be selected from the dropdown.

Step 8. Test Connection

Select the ‘Test connection’ button to see if the integration is working properly. Upon a successful connection, you will see a pop-up message confirming it. 

If there are any issues in connection, you will see the connection status turned to ‘Inactive’. You will have to reauthenticate, add the organization, and test the connection again. 

Thank you for completing your required steps!  Please reach out to your contact on the WorkSpan Professional Services team, and they will test the connection, complete the remaining implementation steps, and notify you when complete.

Migration Steps for Existing Users 

If you are an existing WorkSpan Co-Sell with Microsoft customer migrating to the Microsoft API from Power Automate, the WorkSpan Support team will guide you through each step of this process and ensure a smooth transition to the Microsoft API. When you are ready to begin your migration, follow the steps below, and then the WorkSpan Support team will handle the rest and let you know when the migration is complete.

Step 1. Contact WorkSpan Support

• Reach out to support.workspan.com or email support@workspan.com to initiate the migration process.

Step 2. Navigate to Microsoft Partner Center (MPC) in WorkSpan

• Sign in as a Service User (Administrator) to the WorkSpan App.

• Click on “(1) My Company Profile” in the top right corner. You’ll be taken to the “About” page under “My Company”. 

• Click (2) “Applications” and then click (3) Microsoft > (4) Microsoft Partner Center > (5) MPC Connection.

Step 3. Add & Save the Microsoft Username

• Click "Edit" to add the username 

• The “Edit” popup appears on the screen. Enter your Microsoft username, and click "Save."

ℹ️ NOTE
It is recommended to use a Service Account instead of a Personal (user-based) Account. This is because if a person leaves the organization, their account — and consequently the stored refresh token — will become invalid, which can result in authentication failures.

Step 4. Authorize the Connection

• Click the now-enabled "Authorize" button. You'll be redirected to the Microsoft login.

Step 5. Log in with MPC Admin Credentials

• Use your Microsoft credentials with "Partner Center Admin" access to log in.

Step 6. Accept Permissions

• Review the permissions page and click "Accept." You will be redirected to the WorkSpan Companies Page.

Step 7. Verify Connection Status 

You'll be redirected back to WorkSpan. Check the "Connection status."

• Active Status: Successful Authentication!

• Inactive Status: Re-authenticate from Step 2.

Step 8. Select Organization Name 

Select the correct organization name from the "Select Organization" dropdown and click on Save:

ℹ️ NOTE 
To retrieve your exact organization name, visit the Microsoft Partner Center Account Settings Page. Under the"Company Details" section, you will find the Company name, which should be selected from the dropdown.

Step 9. Test Connection

Select the ‘Test connection’ button to see if the integration is working properly. Upon a successful connection, you will see a pop-up message confirming it. 

If there are any issues in connection, you will see the connection status turned to ‘Inactive’. You will have to reauthenticate, add the organization, and test the connection again. 

Thank you for completing your required steps!  Please reach out to your WorkSpan support contact, and they will test the connection, complete the remaining migration steps, and notify you when complete.

Support