Introduction

StrataVAR Partner Quoting Workspace (PqW) uses API Profiles to control how external systems (such as distributor APIs, CPQ tools, or custom integrations) connect to PqW and what operations they can perform.

An API Profile defines:

• Which operation it is used for (for example, Import Bill of Materials)
• Which BoM types / sources / manufacturers / suppliers / regions / accounts it applies to
• Whether user‑specific or global credentials are required, and how to connect to the external API

API Profiles are created and maintained by administrators in the API Profile Management screen.

Why API Profiles Are Needed

API Profiles let you:

• Map specific BoM types and operations (Cisco Estimate, Distributor BoM, CCW‑R Quote, etc.) to the right external API connection.
• Centralise connection details (base URL, OAuth client IDs/secrets, tokens, etc.) per integration.
• Control scope: which supplier/manufacturer, region, or account each profile applies to.
• Reuse the same profile for multiple imports instead of hard‑coding endpoints.

From a user’s point of view, these profiles drive how “Import Bill of Materials” and related actions behave.

How to Open API Profile Management

• Log in to Salesforce / PqW with an admin user.
• Click the App Launcher (9 dots) in the top‑left.
• In the search box, type API or click on View All option.
• Select API Profile Management under Items.

You will see the API Profiles grid:

Each row is an API Profile (for example, CCWR API Profile, TD Synnex API Profile).

On the top‑right are action buttons, including + to create a new profile.

Creating a New API Profile

Step 1 – Open the New API Profile window

• In API Profile Management, click the “+” button in the top‑right toolbar to open New API Profile window.
• You’ll see multiple sections:
  • Information (API Profile Name and core attributes)
  • Operation / Operation Type (what this profile is for)
  • Additional settings (Description, Base URL, Region, Require User Credential, Connection Details Structure, Connection Verified, Owner)

Step 2 – Fill in basic Information

In the Information section:

• API Profile Name (required) : Enter a clear, unique name. For examples: TD Synnex API Profile, Ingram API Profile. Cisco Estimate / Deal Registration API Profile etc

• Optional context fields such as
  • Org Type – choose the relevant org classification if used in your implementation.
  • Source – allows you to differentiate where the data is coming from (if configured).
• Contract Number, Account, Manufacturer, Supplier

These fields help PqW pick the correct profile when multiple profiles exist.

Step 3 – Select Operation and Operation Type

Continue with other relevant inputs

• Operation: From the Available list, choose the operation this API Profile supports, e.g.: Import Bill of Materials, Import Sales Order. Click on arrow to select or remove the operation type.
• Operation Type: From the Available list, select the specific BoM/operation types this API Profile should handle, e.g.: Cisco Estimate, Deal Registration, CCW-R Quote, Distributor API BoM variants (Ingram, TD Synnex, etc.) Move the relevant types into the Chosen list.

Step 4 – Complete profile details

Scroll further down in the New API Profile window:

• Description: Add a short explanation. Example: Imports Distributor API BoM from TD Synnex for all regions.
• Base URL: Enter the root endpoint for the external API. Example: https://api.distributor.com/v1 or a specific OAuth / BoM endpoint, depending on your integration.
• Region: Choose the geographic region this profile applies to (for example, ALL, US, EMEA, etc.), based on your picklist.
• Require User Credential: Check if each user must provide their own credentials for this API. Leave unchecked if you will use Global Credentials.
• Connection Details Structure: Optionally store JSON or additional configuration instructions that the connector uses (depends on your implementation). The JSON configuration used is mentioned in the code snippet below.
• Connection Verified: Use this checkbox when you’ve successfully tested the profile and confirmed that the integration works.
• Owner: Owner is usually set automatically to an admin user or StrataVAR Admin. This identifies who is responsible for the profile.

//Connection Details Structure JSON//
{
"global": [
{
"name": "oAuthBodyClientId",
"label": "OAuth Body Client Id",
"type": "text",
"required": true,
"maskedValue": false
},
{
"name": "oAuthBodyClientSecret",
"label": "OAuth Body Client Secret",
"type": "text",
"required": true,
"maskedValue": true
},
{
"name": "oAuthBodyGrantType",
"label": "OAuth Body Grant Type",
"type": "text",
"required": true,
"maskedValue": false
},
{
"name": "oAuthHeaderContentType",
"label": "OAuth Header Content Type",
"type": "text",
"required": true,
"maskedValue": false
},
{
"name": "quoteSearchHeaderAccept",
"label": "Quote Search Header Accept",
"type": "text",
"required": true,
"maskedValue": false
},
{
"name": "quoteSearchHeaderIMCustomerNumber",
"label": "Quote Search Header-IM-CustomerNumber",
"type": "text",
"required": true,
"maskedValue": false
},
{
"name": "quoteSearchHeaderIMCountryCode",
"label": "Quote Search Header-IM-CountryCode",
"type": "text",
"required": true,
"maskedValue": false
},
{
"name": "quoteSearchHeaderIMCustomerContact",
"label": "Quote Search Header-IM-CustomerContact",
"type": "text",
"required": true,
"maskedValue": false
},
{
"name": "quoteSearchHeaderIMSenderID",
"label": "Quote Search Header-IM-SenderID",
"type": "text",
"required": true,
"maskedValue": false
},
{
"name": "OAuthUrl",
"label": "OAuth Url",
"type": "text",
"required": true,
"maskedValue": false
},
{
"name": "quoteSearchHeaderContentType",
"label": "Quote Search Header-Content-Type",
"type": "text",
"required": true,
"maskedValue": false
},
{
"name": "quoteAPIURL",
"label": "Quote API URL",
"type": "text",
"required": false,
"maskedValue": false
},
{
"name": "awsEndpoint",
"label": "AWS Endpoint",
"type": "text",
"required": false,
"maskedValue": false
},
{
"name": "middlewareURL",
"label": "Middleware URL",
"type": "text",
"required": true,
"maskedValue": false
},
{
"name": "ciscoAuthenticationVersion",
"label": "Cisco Authentication Version",
"type": "text",
"required": true,
"maskedValue": false
}
],
"user": []
}

Step 5 – Save the API Profile

• Review the inputs provided
• Whether you’re using user or global credentials
• Click Save, or Save & New to immediately start creating another profile.

• Click on refresh icon on the toolbar. 

• The new profile will now appear in the API Profiles grid.

Configuring Global Credentials for an API Profile

Some profiles use Global Credentials instead of, or in addition to, user‑specific credentials. These are edited in a separate Credential window.

Step 1 – Open the Credential editor

• In API Profile Management, locate the API Profile that should use global credentials.
• In the row, use the Global Credentials / Edit action (as configured in your org).
• The Edit Credential window appears. You’ll see:
  • Credential Type – for example, Global.
  • A set of Connection Details fields specific to that integration.

Step 2 – Enter connection details

Populate the Connection Details fields according to the external API’s requirements, for example:

• ClientId / ClientSecret
• OAuth client ID and secret issued by the external provider.
• UniqOrg / Org identifier
• Unique organisation identifier if the API requires one.
• GrantType such as authorization_code, client_credentials, etc.
• IMClientId / IMClientSecret / IMGrantType / IMCustomerNumber / IMTokenURL
• Distributor‑specific fields (e.g. Ingram Micro):
• Customer number
• OAuth endpoints (IMTokenURL)
• Client credentials for their API

The exact field names will vary per integration and are usually provided by your implementation team or the partner’s API documentation.

Step 3 – Save and test

• Click Save in the Edit Credential window.
• Return to the API Profile and run a test import or a dedicated “Test Connection” flow.

Once you have confirmed it works, set Connection Verified on the API Profile.

Editing an Existing API Profile

To adjust an existing profile:

• In API Profile Management, find the profile in the grid. All the fields visible in the grid which have Edit icon visible, can be edited inline.

• Double click on the API profile where you want to modify fields and you will be able to edit all the enabled fields.

• In case you need to modify more fields in the API Profile, click on the Profile name field in the grid.

• You are redirected to API Profile detail page. Here you can modify fields by clicking on editing icon on fields or by Edit option in drop down menu.

• The same window opens, allowing you to modify: API Profile Name, Description, Org Type, Source, Region, Supplier, Manufacturer, Account, Operation / Operation Type mappings, Base URL and other details.

• Click Save to save the changes to Profile.

What Happens After API Profiles Are Configured

Once API Profiles and (if needed) Global Credentials are set up:

• PqW uses the matching profile whenever a user runs an operation like Import Bill of Materials for a configured Operation Type.
• The integration:
  • Calls the external API using the Base URL and connection details from the profile.
  • Applies any region / supplier / manufacturer / account logic defined in the profile.
• Admins can centrally manage and audit:
  • Which integrations exist
  • How they are configured
  • Whether connections have been verified

Common Checks & Troubleshooting

If an API‑based import or integration is failing:

• Check the API Profile mapping
  • Is there a profile whose Operation and Operation Type match the action you’re performing?
  • Is the Region / Supplier / Manufacturer / Account consistent with the data you’re trying to import?
• Verify Base URL and credentials
  • Is the Base URL correct (environment, path, protocol)?
  • Are the ClientId / ClientSecret / token URLs up to date?
• Confirm the right Credential Type
  • If using Global credentials, ensure the Credential record is filled in and saved.
  • If Require User Credential is checked, confirm the user has their own credentials configured (if your implementation supports that).
• Check “Connection Verified”
  • If unchecked, consider testing and then marking it as verified once confirmed.
• Review error messages
  • API error responses often indicate missing or incorrect credentials/URLs; use them together with the profile configuration to diagnose issues.

Conclusion

API Profiles in PqW give admins a structured way to manage and secure all external API integrations:

• Create profiles in API Profile Management via the + button.
• Configure operations, BoM types, base URLs, and regions.
• Set up Global Credentials where needed and mark connections as verified.
• Edit profiles as integrations evolve, while keeping a clear mapping between operations and external systems.