Using Voyager's REST API

Voyager provides a REST API for developers to use to integrate enterprise applications.

Access and Permissions

Authentication is done with Basic Authentication. Operations that change resource state require the authenticated user to have the appropriate permission granted.

Supported Media Types

Our REST API supports JSON and XML data formats. When requesting information content negotiation is handled by the extension at the end of a URL. See Constructing REST API Queries for detailed information.

Accessing the API

• From a local Voyager instance, go to
  http://localhost:8888/api/docs/
  
  

• On the Voyager demo site, go to:
  http://odn.voyagersearch.com/api/rest/docs/

Open

Try the API

The API Explorer has a tool for you to call the end points without having to write any code. Select the resource you want to browse, pick an operation to perform, fill in any required data and click Try it out!.

Using DELETE & PUT 

Developers integrating their applications with Voyager may find that their development environment cannot send an HTTP request with a verb other than GET or POST (Flash, browser forms, etc). This can be remedied by appending a URL parameter to indicate the true intention of the request.