Requesting a WSKey from OCLC Article Exchange

Follow

Starting with ILLiad 8.4, you will need a Web Service Key (WSKey) to utilize new Article Exchange features. You will also need the WSKey for other OCLC functionality in ILLiad in the future.

Create OCLC Account

Before you are able to request a WSKey from OCLC, you first need to have an OCLC account set up. This account is separate from your OCLC/Firstsearch Admin Authorization and password (which you will use later in this process). It's recommended to use your institution's contact information instead of your personal information when creating this account. If you have a shared server ILLiad installation and you have multiple OCLC symbols, you will need to request a WSKey and secret for each symbol.

  1. Go to the Developer Network WSKey user interface.

  2. Enter your OCLC symbol, institution name, or zip code and click Continue.

  3. On the Sign In page, click Create new account.

    • If you already have an OCLC WorldCat account, log in with your username and password.
      CreateAccount.png

  4. Fill out the application to create an OCLC services account. See image below.
    "OCLCServices.png

 

Request the WSKey

  1. After you have an account you can request your WSKey, click Request a Production WSKey.
  2. Fill in the Request a WSKey page as follows—
    1. Environment: ProductionServices. Select the following:
      1. Article Exchange
      2. ILL Fee Management API
      3. Interlibrary Loan Policies Directory
      4. *Optional- If you are going to be using the Item Availability, select the Availability Query.
    2. WSKey Name: ILLiad
    3. Reason: ILLiad functionality
    4. Registry ID: Beginning April 2018, you will need to include the Registry ID. Here is how to locate your libraries Registry ID.
      1. Open http://www.worldcat.org/webservices/registry/xsl/identifiers.
      2. Search for your institution by name or OCLC symbol.
      3. Select Identifiers from the left menu.
      4. Your Idenitifer will display in the new window that opens.
    5. Symbol: (Your institution's OCLC symbol)
    6. Redirect URI: (leave blank)
    7. Usage: (leave blank)
  3. You will be notified once the key has been created by OCLC Order Department.

Generate the WSKey Secret

  1. After receiving the notification, you will need to generate the WSKey Secret.
    1. Select WSKeys.
    2. Click the link under the Secret column to display your WSKey secret.
  2. To learn how to configure ILLiad to use the WSKey and secret, see Configuring Article Exchange Integration.

Add WSKey to Customization Manager

  1. Copy the information to the Customization Manager under System | OCLC. 
    1. Add the generated key from the OCLC Order Department to the OCLCWebServiceV2APIKey key.
    2. Add the generated WSKey secret to the OCLCWebServiceV2APISecret key.
    3. *Optional- If you selected Item Availablity during your WSKey request, add the information to the OCLCItemAvailabilityWsKey.

 

 

 

Questions?

If this article didn’t resolve your issue, please take a moment and answer a few questions to help improve our documentation:

Feedback