Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The application program interface (API) is a set of routines, protocols, and tools for building software applications.  The Sierra API allows access to types of records for a third party application e.g. bib records, item records, patron records.  A third party application can harvest information from Sierra via APIs and deliver it back continually to their application.  The Sierra API Keys authorize an external application to use your Sierra system's API.

Top of page

Accessing

...

, creating new, and editing API Keys

The Sierra API Keys must be accessed through your library’s admin site.  Each library will have a server hostname that is set up by Innovative. 

...

Click on the Sierra API Keys link under the Other Web Applications

...

The API Keys page will display all the keys created by your library.  It will list the Client, API Key, Expiration Date, and Status.

...

Info

The Status column will either show Enabled or Pending.  When the API is created, it will show a pending status.  Once the person who was sent the new API key has activated it, the status will change to Enabled.

...