Using C-Language K2 APIs

The K2 Developer product includes C APIs that allow application programmers to quickly and efficiently create customized user applications for searching and displaying the results of search operations. For collection search, programming examples in C are provided in the Verity K2 Client Programming Guide.

The K2 client C API uses a simple, connectionless HTTP-style protocol, which reduces latency and overhead for most common operations by bundling common API usage scenarios into a single call. As a consequence, latency is greatly reduced, leading to highly responsive applications.

The K2 client API is specifically designed to support asynchronous operation, so that a single instance of the client application can accept user input while the K2 Server processes the request.

The K2 application-level C APIs include the following:

Client C API. Interface to Verity search functionality; used to perform collection-level search and tree search, to obtain system information, to authenticate to repositories, to perform K2 login, and to obtain user/group information.

 

Documented in the Verity K2 Client Programming Guide.

Viewing Service C API. Interface to the Verity viewing service; used to convert indexed documents to HTML format—based in various templates—and display the results to the user.

 

Documented in the Verity K2 Viewing Service Programming Guide.

Spider C API. Interface to the K2 Spider controller; used to administer indexing of collections. This API provides the same functionality as the VIndex Java API.

 

Documented in the Verity K2 Spider Programming Guide.

Profiler C API. Interface to the K2 Profiler service; used to evaluate documents against a set of predefined profiles (queries) to obtain a list of profiles matched to each document, plus relevance scores.

 

Documented in the Verity K2 Profiler Programming Guide.

Administration C API. Interface to K2 administrative functionality; used to change and manage the K2 system configuration. This API provides the same functionality as K2 Dashboard or the rcadmin command-line tool.

 

Documented in the Verity K2 Administration Programming Guide.

Security API. Interface to the Verity Ticket Server; used to add or remove administrators or users and to manipulate security information.

 

Documented in the Verity K2 Security Programming Guide.

ODK C APIs. Interfaces to ODK; used to conduct parametric selections, use thematic mapping and the LRC, and manipulate topic sets, parametric indexes, and parametric trees.

 

Documented in the Verity Organization Developer’s Kit Programming Guide