Skip to content

Configuration

Jump to bottom
bmckinney edited this page Mar 1, 2017 · 8 revisions

Configuration

EDS API Profile

You'll need to have an EDS API profile in EBSCOadmin. You can request this at eds@ebscohost.com, or you can create a new EDS API profile yourself using the Profile Maintenance feature.

Be sure you add content to your EDS API profile (via the Databases tab) so it will return results.

Authentication

An EDS API session requires authentication. There are two methods available and both are configured in EBSCOadmin:

1. IP address

  • Use this if you plan to access the API from server(s) with a fixed IP address, or via a proxy server.
  • Create and manage IP address lists in the top-level Authentication tab at the top of the EBSCOadmin screen and select the IP Address sub-tab.

2. User ID and password

  • Use this if you might connect to the API from machines outside your network, or from many different addresses.
  • Create a user ID and password to access your API profile in the Authentication tab at the top of the EBSCOadmin screen. Make sure the Group associated with the login you create is the group that contains your EDS API profile.

EBSCO Support (eds@ebscohost.com) can help you set up an EDS API profile and get a userID and password for it if you are unfamiliar with EBSCOadmin.

Session

You can configure the EDS session in two ways:

1. Using environment variables

EDS_PROFILE=profile_name
EDS_GUEST=n
EDS_USER=your_user_id
EDS_PASS=secret
EDS_AUTH=ip
EDS_ORG=your_institution

Once set, you create a session like this:

session = EBSCO::EDS::Session.new

2. Using an options hash

session = EBSCO::EDS::Session.new({
      :profile =>'eds-api', :
      :user =>'your_user_id', 
      :pass =>'secret', 
      :guest => false, 
      :org => 'my organization'})

Clone this wiki locally