Community primer

If you are new to Khoros Community, this is the right place to get yourself oriented. This page will help you to become acquainted with some key concepts. This primer links you to helpful documentation about Community and the Community REST API.

Note: The Community Android SDK uses Community API v2 data models. It does not use API v1.

While our SDK API providers enable you to create a native Community integration without diving deep into our Community REST API, you’ll benefit from doing some background reading first.

Here are some guides to get you up to speed.

• Community concepts - This guide describes key community concepts. If you’re new to Community, be sure to read the Community structure and terminology section to understand our node hierarchy and data structure for Community boards and messages.

• Getting started with the Community API v2

• Using LiQL - LiQL (Lithium Query Language) is the query language you’ll use if you need to make custom requests to get metadata from our API v2 resources. This guide explains the LiQL syntax. You’ll use LiQL if you create custom requests using getGenericLiqlGetClient(LiClientRequestParams liClientRequestParams).

• The API v2 response - This guide explains the format of the response to a Community API v2 request

• LiQL collection and object index - This page lists our API v2 resources with links to pages describing resource fields, filters, and sort options supported in LiQL queries.

Remember that you can also use Khoros' own community to help find information. For Admin guides, see our Khoros Communities Documentation Knowledge Base. To discuss the SDK and API with other developers, try searching or posting a question to our Developer Discussion forum.