Adlib API home page > Documentation

Documentation

The documentation referred to here, consists of web pages and/or manuals in Microsoft Word or Adobe PDF format.

The Adlib API in detail

Open documentation describing the highlights of the Adlib API and the advantages over its predecessor wwwopac.exe (a CGI extension).

Open a concise overview of the image handling functionality in the Adlib API.

Open documentation about the differences between the default and structured XML types for pointer files.

Choosing your implementation

The Adlib API can be implemented using a jQuery plugin, Adlib.Data.dll or Url requests.

Open an overview of the advantages and disadvantages of each flavour.

Optional JSON output

Besides XML, the output format JSON can be returned by wwwopac.ashx.

Open the documentation about JSON.

Adlib system requirements

For the Adlib API to function, certain hardware and software requirements need to be met, and for image retrieval some adjustments need to be made to the structure of database(s), using Adlib Designer.

Open the system requirements documentation.

Open "Installation of Internet Server 3.1.0.doc" (Word document).

Configuring your Adlib API system

The adlibweb.xml file is used to configure your wwwopac. In it, you specify paths to the data folder, and other relevant folders, you indicate which user authentication service to use, you configure image retrieval, and you list the fields that must be included in the search result.

Open an example of an adlibweb.xml file.

Open documentation explaining the possible settings in adlibweb.xml.