API Documentation

This section documents all of the platform APIs for Telligent Community.

The Telligent Community Platform APIs consist of:

•  In-Process API Documentation 
•  Plugin API Documentation 
•  REST API Documentation 
•  Widget, Theme, and Automation APIs 

These versioned APIs allow developers to customize and innovate on the platform while not having to worry about breaking changes when new versions of the platform are released.

The Platform API is exposed to extensions via a REST API, Scripting (Widget, Theme, Email, Automation, and Embeddables) API, Plugin API, and an in-Process API. The Platform API (and only the Platform API) is guaranteed to work through upgrades and be documented through release notes. Only the Platform API is supported for customization and subject to versioning, obsolescence policies, and upgrade safety. 

How do you ensure that you're using the Platform API? Follow these guidelines:

1. If you're creating a Studio Widget, Theme, Email, Automation, or Embeddable, you only have access to the Platform API. There is nothing additional that you need to verify.
2. If you're using the REST API, you only have access to the Platform API. There is nothing additional that you need to verify.
3. If you're writing .net code that runs within the Verint Community platform, ensure that you're only interacting with Telligent.Evolution.* assemblies via classes, enumerations, and interfaces that exist within the Telligent.Evolution.Extensibility.* namespace. The Platform API and plugin types exist solely in this namespace. Only this namespace is guaranteed to work through upgrades.

Note that database resources created by the Verint Community platform are not considered part of the supported API and are subject to change without notice.