Knowledge Management System REST APIs

On this page:


Overview

The IU Knowledge Management System serves documents via two RESTful APIs, which let users search for and retrieve KMS documents.

The KMS standard API allows access to any authorized content, including restricted content; documents can also be customized for specific audiences by the KM team. The standard API uses Basic Authentication (BasicAuth) and requires a user account provisioned in the KMS.

The KMS public API allows access only to public KMS documents (that is, documents visible in the IU Knowledge Base to any unauthenticated user), without customization. It is an open API, and requires no authentication or coordination with the KM team.

Comparison of standard and public APIs

The standard API is intended for server-side applications, where BasicAuth credentials can be safely managed; the public API is ideal for client-side applications, but is useful wherever public KB content is needed.

Standard API Public API
Authorization BasicAuth none
Content All provisioned audiences Public content only
Document format JSON or XHTML JSON
Search type Full-text (Solr) Keyterms (semantic)
Caching via Document UUID ETag or Last-Modified
Other features Sitemap Document fragments
Note:
UITS Knowledge Management maintains all content in the KMS, and also manages the user accounts for the standard API. Because of this, the team can anticipate the needs and potential effects on these users when content changes.

However, if you use the public API, you may not be warned in advance when documents are modified, archived, or removed. This is especially true when applications access specific documents, rather than retrieve documents by semantic keyterms.

Standard API

Request an account

To request a KMSREST account for your service, contact kb@iu.edu; specify a group email address that will be responsible for the REST account. After reviewing your needs, KMS admins will create your account

For details, see KMSREST: User creation.

Documentation

See KMSREST standard API.

Code samples

Some sample code is available on the IU enterprise GitHub:

Public API

See KMSREST public API.

Related documents

This is document rest in the Knowledge Base.
Last modified on 2018-11-13 13:32:56.

Contact us

For help or to comment, email the UITS Support Center.