API

Klixo's XML Search Engine Web Service is a powerful and customisable search engine service that integrates with any website. The following article describes how to query the service using a URI (link) or a Form. The web service offers the following features:

• Keyword search
• AND, OR and NOT searches
• Exact phrase matching
• Search one or more specific (custom) fields
• Paged results with variable page results lengths
• Re-run of saved queries to simplify result navigation for complex queries
• 100% customisable search results page which can display any saved content (including images)
• Widely used query syntax means that search referals are easily read in web stats logs
• XML web service

Example URI

http://klixo.net.nz/klixo/search.asp?q=daniel&scope=website&caller=http%3A%2F%2Fklixo.net.nz%2Fklixo%2F

RPC Endpoint

http://klixo.net.nz/klixo/search.asp

Parameters

• q - query phrase
• scope - can be "website" to search only the caller website or "network" to search the entire Klixo network of sites.
• caller - the url of the website making the search request. If a custom search results template has been loaded for the caller website, Klixo will use this template instead of the standard built-in template
• start - the number of the first result to display on a page
• num - the number of results to display in a page
• kdoctype - the type of Klixo documents to return in the results. Possible values are "Story", "Page" or "Page Story"
• fieldname - the name of a custom field to search
• queryid - the Id of a saved Query to run
• queryguid - the GUID of a saved Query to run
• xml - when "true" the raw unformatted XML data will be returned
• pageid - optional parameter of a page ID. When specified the website DOM and specified page DOM is returned

Requests can be HTTP GET or POST.

Full text search

Set a single q parameter with the terms that you wish to search on to perform a simple full text search of your website, or all Klixo websites, i.e

http://klixo.net.nz/klixo/search.asp?q=daniel&scope=website&caller=http%3A%2F%2Fklixo.net.nz%2Fklixo%2F

Custom Field Search

Search specific custom fields in Klixo by specifying one or more fieldname parameters. For every fieldname parameter that you specify, there must be a matching q parameter. If you specify Field Names, only the specified fields will be searched.

Saved Queries

After a query has been run for the first name, you can rerun it without having to pass all of the fieldname and q parameters back by passing the QueryID and QueryGUID, which are available in the search results XML DOM.

Results XML

Full documentation of the search results DOM is coming soon. In the meantime you can view the simple structure of this XML by appending "&xml=true" to your query, e.g.

http://klixo.net.nz/klixo/search.asp?q=daniel&scope=website&caller=http%3A%2F%2Fklixo.net.nz%2Fklixo%2F&xml=true

Transform this data using XSLT to produce customised search results, XML Spy is an excellent tool for doing this. Klixo Support will assist you in installing your XSLT.

Contact us for sample code or more information.