Sierra REST API Interactive Documentation
With the Sierra REST API Interactive Documentation, you can view API operations and parameters and generate JSON or XML responses. It helps you to understand the available resources and to design appropriate URLs to retrieve the data you need.
You can see the Interactive Documentation on the Innovative Sandbox server at:
https://sandbox.iii.com/iii/sierra-api/swagger/index.html
The server returns data from a sample database maintained by Innovative. To view data from your Sierra system, you must use the Interactive Documentation installed on your library's server.
Using the Interactive Documentation
Viewing Your Library's Data
To view the Interactive Documentation set that accesses your library's data, construct a URL in your browser's address bar according to the following pattern:
https://<yourServerName>/<path>/swagger/index.html
The default resource "path" portion of the URL is "iii/sierra-api". If your system was installed with a nonstandard resource path, you must construct the URL using your custom path.
Try It Out!
If you have a client key and secret, enter them into the boxes at the top of the Interactive Documentation page. Authorization enables the Try it out! buttons. Sample results include:
- the request URL used to retrieve the data.
- the response body, showing sample data from the Sierra database.
- the response code.
- the response headers.
Client Key and Client Secret
Innovative administers client keys for the
Each library administers distribution of client keys for access to its system. Contact your library's Sierra Administrator for access to the Sierra REST API on its system.
Libraries use the Sierra administration application to create, enable, and disable Sierra REST API keys.
Required Parameters
In the Interactive Documentation, the names of required parameters appear in bold text and the Value text box indicates that an entry is required. All other parameters are optional.