Search APIs

Procurement can configure any available Search APIs and enable them for selected buyers. This will allow those buyers to receive search results that include products obtained from those suppliers' or providers' Search API catalogues.

To view all available Search APIs, navigate to the Search APIs page of the platform within the Settings area, or by searching for Search APIs in the main search bar.

The Search APIs page displays a table of all available Search APIs. These can be filtered by Connected or Not Connected Search APIs. Connected Search APIs have 1 or more configurations. Multiple configurations may be needed for reasons such as to enable multiple regions. Clicking on a Search API with configurations will take you to a page where the configurations can be viewed and managed.

1. To add the first configuration to a Search API, click the Configure button for the appropriate row on the Search APIs page in the Settings area of the platform.

2. Enter a name for the configuration and select which preset/s of users to apply the configuraiton to.

3. Fill out the required Config Details for this configuration. These fields will vary based on the selected Search API, and be specific to their systems and authentication process.

4. Optionally click the Enabled toggle to change it to Disabled - this will ensure the configuration isn't immediately live for buyers after saving it.

5. Review all entries then click Save to create the configuration.

6. To ensure Search API products for this configuration can be found and purchased by buyers, check that appropriate sharing settings are in place for the relevant supplier - see more information here.

1. To add additional configurations to a Search API, click on the appropriate row on the Search APIs page in the Settings area of the platform.

2. All current configurations can be seen in the table on this detail page for the selected Search API. Click the + New config button to begin creating a new configuration.

3. Enter a name for the configuration and select which preset/s of users to apply the configuraiton to.

4. Fill out the required Config Details for this configuration. These fields will vary based on the selected Search API, and be specific to their systems and authentication process.

5. Optionally click the Enabled toggle to change it to Disabled - this will ensure the configuration isn't immediately live for buyers after saving it.

6. Review all entries then click Save to create the configuration.

7. To ensure Search API products for this configuration can be found and purchased by buyers, check that appropriate sharing settings are in place for the relevant supplier - see more information here.

To edit a Search API configuration, either click the appropriate row in the configuration table for the selected Search API, or open the menu for the row and select Edit.

To remove a Search API configuration, open the menu for the appropriate configuration row of the selected Search API and select Remove.

To enable a disabled Search API configuration, open the menu for the appropriate configuration row and select Enable.

To disable an enabled Search API configuration, open the menu for the appropriate configuration row and select Disable.

For appropriate buyers to be able to view and purchase the products of a particular Search API, relevant sharing settings must be configured for the supplier in question, with the sharing settings including supplier punchout identifiers and relevant users (presets or otherwise).

To adjust the sharing settings, head over to the corresponding supplier page for the Search API to view any existing sharing settings (e.g. the Scientist.com supplier for the Scientist.com Search API). Navigate to the Sharing Settings tab to edit or add any additional sharing settings.

Not all features can be utilised when the method of data provision is through a Search API integration. The following table compares available features through the 3 different methods of supplier data provision.