The ability to discover information about applications in a hosted environment is essential in an integration perspective. Such information include features/services offered by the application and applications’ type and/or identity. This documents describes how such information is gathered and how it is offered by Chemaxon Synergy to registered applications.
Each application MUST provide a JSON document which contains information about application’s address, name, identity and supported features.
displayName - application name displayed in Synergy
address - base url address of the application
features - list of available features with configuration
identities- list of application identities
This JSON should be exposed at a publicly available URL with a content type of “application/json; charset=utf-8”.
Application is easily categorised by its list of identities which can be used for navigation, grouping and integration based on identity. Application identity is described by
type. Application can have more than one identity (see examples).
category - is an area, functionality or capability that is described in this block.
type - the quality or implementation of the category.
Values of the categories and types are validated and should be set according to this documentation otherwise the registration will be blocked. The following categories are mandatory but other custom ones can be added without any limitation.
Every application SHOULD have list of SF-XXX features. Every feature contains a
namespace and map of
attributes describing the configuration required for a given feature.
namespace - sensible identifier of the feature (like
workflow-name/feature-name and so on),
synergy/* is the reserved namespace for the features used by the synergy
attributes - map of feature attributes. Number of items inside attributes is not limited and it depends on the feature what attributes are necessary for using the feature
Synergy also defines few features required from applications for its own functionality.
Web endpoints (optional)
/api/discover endpoint where applications can send HTTP GET request for list of available applications and their application info. Request has to be authenticated using JWT token header (see authentication page) either for current user or service itself.
Application info uses
synergy/app-info namespace and single