Giving information about the state of your registered application in Synergy

Please note that this is our alpha version. The interfaces are not yet stable and might change.

Documentation of Application Info Endpoint

Applications which want to integrate with Synergy can provide REST web service containing information about the application itself. URL path of this service is not limited. The format of the output data has to follow this JSON object:

Example

{
"displayName": "Demo Application",
"address": "http://demo-application.chemaxon.com/",
"iconUrl": "http://demo-application.chemaxon.com/images/icon.png",
"directlyAccessed": false,
"healthCheckUrl": "http://demo-application.chemaxon.com/health-check"
}

  • displayName - application name displayed in Synergy

  • address - url address of the application

  • iconUrl - application icon url

  • directlyAccessed - option stating whether the application is accessed directly during communication with application or through the Synergy proxy

  • healthCheckUrl - application health check endpoint URL (URL path is not limited)

Documentation of Health Check Endpoint

For showing application status in Synergy portal, the application must implement health check REST service. It is a simple service returning information about the application status. JSON service output is following:

Example

{
"status": "UP",
"description": ""
}

  • status - application status:

    • "UP": This should be returned by the service if the application is running and providing health endpoint.

    • "SHUTTING_DOWN": This should be returned by the service if the application is running, providing health endpoint but marked to shut down.

    • " ERROR": This should be returned by the service if the application is running, providing health endpoint but emitting error status.

  • description - application status description