Configuring API Credentials

The EDS API dashboard provides a centralized location to adjust settings that impact the functionality of EBSCO Discovery Service API. 

The EDS API credentials must be configured before an EDS search can be performed and have results appear directly in the Stacks site. To configure these API settings you will need:

• Server Address
• Username
• Password
• Profile

1. From the Dashboard, click the Integrations tile
2. Click the Search tile, then click the EBSCO Discovery Service tile
3. Click the Settings tab (near the top of the page)
4. Click the API Credentials menu on the left
   1. Server Address, enter the EDS API endpoint URL
   2. Username, enter the EBSCO Discovery Service (EDS) API username
   3. Password, enter the EBSCO Discovery Service (EDS) API password
   4. Profile, enter the EBSCO Discovery Service (EDS) API profile ID
   5. Click Save Configuration when finished

Read More Settings

The Read More section of the EDS Settings dashboard page allow administrators to configure access to a permanent link (plink) that is exposed by the Read More button in EBSCO Discovery Service searches. Expand the Read More section and provide the following information:

1. Follow steps 1 - 3 from the Configuring API Credentials section above
2. Click the Read More menu tab on the left side of the screen
   1. Authentication Type, enter the authentication type syntax configured in EBSCOhost
      1. If more than one syntax is configured, separate them with a comma
   2. Customer ID, enter the EBSCO Customer ID
      1. Contact your EBSCO representative if you do not have this information
   3. Group ID, enter the group ID parameter of the plink URL, found in EBSCOadmin
      1. Note: this is typically configured by your Implementation Project Manager during the initial implementation of your site, if you already subscribe to EDS
   4. Click Save Configuration when finished

Limiters

Stacks administrators can control the following behaviors from the Limiters section in the EBSCO Discovery Service dashboard page. The list of EDS Limiters, provided by the EDS API, will appear within an expandable tab on the EDS Search results page. 

1. Follow steps 1 - 3 from the Configuring API Credentials section above
2. Click the Limiters menu tab on the left side of the screen
   1. Enable Limiters Tab, when checked, and expanded tab will appear above the facet filters in an EDS API search
      1. This tab will contain checkboxes users can check to override the default limiter(s) set in the EDS API profile
   2. Expand Limiters Tab, when checked, the Limiters tab will be expanded by default
   3. Hide Limiters, check the boxes beside each limiter you wish to hide from the EDS API search results page, to hide all, uncheck the Enable Limiters Tab box above 
      1. Full Text
      2. References Available
      3. Academic (Peer-Reviewed) Journals
      4. Available in Library Collection
   4. Language Limiters
      1. Enable Language Limiters, when checked, language limiters will appear on the EDS API search results page
   5. Click Save Configuration when finished

Expanders

Stacks administrators can also control the following behaviors from the Expanders Tab in the EBSCO Discovery Service dashboard page. The list of EDS Expanders, provided by the EDS API, appear in an expandable tab on the EDS Search results page. 

1. Follow steps 1 - 3 from the Configuring API Credentials section above
2. Click the Expanders menu tab on the left side of the screen
   1. Enable Expanders tab, when checked, an expandable tab will appear above the facet filters in the EDS API search.
      1. This tab will contain checkboxes users can check to override the default expander(s) set in the EDS API profile
   2. Click Save Configuration when finished

Facets

"Facets" are a way to quickly and easily filter and narrow down search results based on specific criteria. Essentially, facets allow users to refine their search results by selecting specific categories, topics, authors, publication dates, and other relevant criteria.

When the options located within the facets tab of the EDS API settings dashboard page is enabled, they will appear opened or expanded on the EDS API Search results page, exposing specific facets that end users can click on to filter their search results. For the options listed in this section of the EDS API Settings, when the respective box(es) are checked, these groupings will be opened by default, leaving them unchecked will collapse them by default.

1. Follow steps 1 - 3 from the Configuring API Credentials section above
2. Click the Facets menu tab on the left side of the screen, for the options listed, check the box for the accordion to open by default for the selected option(s)
   1. Open Refine search accordion on page load
   2. Open Source Type facet filter
   3. Open Subject facet filter
   4. Open Publication facet filter
   5. Open Publisher facet filter
   6. Open Language facet filter
   7. Open Geography facet filter
   8. Open Content Provider facet filter
   9. Click Save Configuration when finished

Placards

Here administrators can enable placards in the EDS API search.

1. Follow steps 1 - 3 from the Configuring API Credentials section above
2. Click the Placards menu tab on the left side of the screen
   1. Enable Research Starters, when checked, and if a research starter is available, it will appear as the first search result in the list of search results
      1. Research starters provide quick summaries of the most popular topics in EDS
   2. Disable Research Starters for anonymous users, check this box to disable research starters for unauthenticated (or anonymous) users
   3. Enable Exact Match Publication, when enabled, and if a single publication is a match for the query, the publication's details will be displayed in its own placard in the top left-hand column beside the search results
      1. If more than one publication is an exact match, then no publication will be featured
      2. If enabled, the exact match placard can also be added as a bento box in bento searches
   4. Enable EDS Autocomplete, when checked, will provide search suggestions that appear based on what the user types into the search bar
   5. Click Save Configuration when finished

Bento Search

The Bento Search section on the EDS Settings dashboard page allow you to configure specific behaviors for EDS Bento search functionality.

1. Follow steps 1 - 3 from the Configuring API Credentials section above
2. Click the Bento Search menu tab on the left side of the screen
   1. Hide refine search results button, when checked, the refine search button that typically appears near the top of the Bento results page, will be hidden
3. Click Save Configuration when finished

Result Links

1. Follow steps 1 - 3 from the Configuring API Credentials section above
2. Click the Result Links menu tab on the left side of the screen
   1. Enable Open Access Databases, this will allow anonymous users access to "Read More" links for content coming from the selected Open Access & partner databases
      1. Check the box(es) for the databases to enable 
   2. Enable Unpaywall Fallback, when checked, this will enable the Unpaywall API which provides access to Open Access databases and repositories for items based on their DOI
      1. Allow Unpaywall Access to Anonymous Users, check this box to allow unauthenticated (anonymous) users access to the unpaywall api features
      2. Unpaywall Authentication Method, select the appropriate radio option:
         1. Email
         2. API Key
      3. Enable Unpaywall Caching, when checked, results from previous API calls are cached, this can reduce the number of calls that need to be made
      4. Enable Unpaywall Exception Logging, check this box to enable exception logging
   3. Click Save Configuration when finished

Resource Flow

The Resource Flow feature in Stacks has the ability to integrate with EDS to retrieve relevant results as a resource flow item.

1. Follow steps 1 - 3 from the Configuring API Credentials section above
2. Click the Resource Flow menu tab on the left side of the screen
   1. Enable EDS Query for Resource Flows, when checked, and when adding new resources to a resource flow, a Query EDS button will appear
      1. The user can query EDS for a resource, if found and depending on the information available, the fields below may auto-populate with information for the resource
   2. Click Save Configuration when finished

Related Content

1. Follow steps 1 - 3 from the Configuring API Credentials section above
2. Click the Related Content menu tab on the left side of the screen
   1. Enable Related Content Block
   2. Click Save Configuration when finished

Citation Badge

Using Scite.ai Citation Badge, this will display the context of the citation, describing whether the article supports, mentions, or contrasts the cited claims. It also includes a label indicating in which section the citation was made.

1. Follow steps 1 - 3 from the Configuring API Credentials section above
2. Click the Citation Badge menu tab on the left side of the screen
   1. Enable Citation Type Badge, when checked will enable the citation type badge
   2. Click Save Configuration when finished