How To Integrate Quality Hub
Quality Hub API
Quality Hub provides a custom-built API to process requests of different kinds and retrieve their status.
To learn how to enable the API, please refer to Configuring Quality Hub.
Authentication Methods
OAuth 2.0
If you chose OAuth 2.0 as the authentication method, please refer to Salesforce’s documentation on how to authenticate using the OAuth 2.0 protocol.
Other Authentication Methods
If you choose None or API Key as the authentication method, follow these extra steps to make the API available to external systems.
Create a Site
1. Open the Salesforce Setup page by clicking the gear icon on the top right and selecting Setup.
2. Click on User Interface > Sites and Domains > Sites on the left side menu.
3. If there aren’t any other sites already, read and accept the Salesforce Site Terms of Use, and click Register My Salesforce Site Domain.
4. Create a new Site by clicking on the New button.
5. Enter the details for your new site. For example:
a. Site Label: Quality Hub API
b. Site Name: Quality_Hub_API
c. Site Description: This site is used to expose the Quality Hub API to external systems.
d. Active: Checked
e. Active Site Home Page: InMaintenance
6. Click Save.
7. The site should now be visible in the list of sites.
8. You must notedown the site’s URL, which is needed later to call the API from external systems.
For example: https://customization-efficiency-b4-dev-ed.scratch.my.salesforce-sites.com/provar
Configure the Public Access Settings
- Open the site created previously.
- Click the Public Access Settings button.
- (Optional) Scroll toward the bottom to define Login Hours or Login IP
Ranges if you want to restrict usage of the Quality Hub API to particular
hour ranges or IP addresses. - Click on the View Users button.
- Click on the user’s Full Name to open it.
- Scroll down to the Permission Set Assignments section and click on Edit
Assignments. - Select the Quality Hub – API permission set and click Save.