Voyager APIs
Voyager Open Interfaces Overview
The Voyager open interfaces are sets of application programming interfaces (APIs) that enable the interaction between Voyager and other applications.
There are two types of open interfaces in Voyager: XML over HTTP and RESTful APIs.
Both types of interfaces are provided via the VXWS service in Voyager.
Check the XSDs for required encoding.
Voyager XML over HTTP Services
Voyager also provides a standard set of services structured around the Voyager core services. The services are in an XML over HTTP format and can also be used by applications that want to interact with Voyager with background services. The XML over HTTP services provide search and result set services as well as circulation activities.
The services are provided through the VXWS service, and all interactions must go through the VXWS port.
For a complete list of services, see the XML over HTTP Web Services page.
Voyager RESTful Web Services
RESTful APIs provide access to Voyager services in a hierarchical format, structured on the recommended DLF format, and enables client discovery tools to build a suite of interfaces for the library’s patrons on top of the Voyager API. This enables the implementation of a single interface that efficiently handles both the discovery and fulfillment actions.
The APIs can be divided into two categories:
1. Patron/Account related
2. Bib/Holdings/Item related
The services are provided through the VXWS service, and all interactions must go through the VXWS port.
For more information, see the RESTful Web Services page.