The Zimbra Social .85 platform clearly identifies internal and public-facing APIs. The Platform API is exposed to extensions via a REST API, Widget and Email Extension 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. To ensure upgrade safety, Telligent strongly recommends using only the Platform API to implement customizations.
How do you ensure that you're using the Platform API? Follow these guidelines:
- If you're creating a Studio Widget or an email template, you only have access to the Platform API. There is nothing additional that you need to verify.
- If you're using the REST API, you only have access to the Platform API. There is nothing additional that you need to verify.
- If you're writing .net code that runs within the Zimbra Social 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.
To fully ensure upgrade safety, Zimbra recommends using only the Platform API to implement extensions.