Using Widget API
In Customise Widget Configuration we've setup the Widget, similar to onSetup
hook the Iframe Client API provides onReady
hook. Once onReady
is called, Annoto API actions can be performed:
The api
can be used to accomplish various tasks such as dynamically hide/show the widget, load new configuration and maybe the most common task to perform Single Sign On (SSO) authentication as demonstrated above.
For full API documentation, please refer to the AnnotoApi Reference.
The api object provided by the Iframe Client annoto.onReady
has limited capabilities:
It does not support Promise based usage. It supports only callbacks.
It support only the following methods: auth, load, close, show, hide, registerOriginProvider, logout.
registerOriginProvider supports only getPageUrl.
For more information regarding SSO, please refer to the Annoto SSO Technical Guide or contact us at support@annoto.net.
Last updated