Web Services - AFS

AFS Integration Guide

Product
AFS
AFS_Version
7.9
Category
Reference Guide

AFS v7 provides four REST resources covering the different functionalities of a search service.

Resource

Role

acp

AutoComPletion server (input "fo", output "foo" and "foobar")

search

Search engine, returns documents in a corpus matching a query

click

Records user clicks on items on a reply page (replies, facets, pager…)

content

Content Repository, allows access to PaF documents (either live access or access to a copy synchronized with a reply database)

Each resource is implemented by an AFS v7 binary, which has the same name (for example acp for auto completion). These web services are fully REST-compliant and are in particular stateless. No caching is done by AFS v7, so that:

  • There is no latency between the time when an index is updated and when it is available to users since there is no need to wait for cached queries to expire.
  • Repeated calls to AFS with the same query will account for several, and not one, AFS queries.

All AFS v7 web services support GET and POST verbs (POST is usually needed to ensure reliable transmission of long queries)