Server Widgets API is a REST API provided by Content Glass for sharing widgets on top of websites (and apps). The difference from CG-Button or other apps running on a webpage (or app) is that widgets are created by making an API request and not by an app running on a specific web page or app.
Server Widgets API is intend to be used by service providers that want to add into their product an algorithm for sharing pice of information or logic with their customers. Here are few examples:
eCard Extended Sharing
eCards service providers can use Server Widgets API to add into eCard distribution procedure a logic for sharing the eCard on top of websites. So instead of just visiting the provider's website to see the eCard, a user may be directed to other websites, such as YouTube for example, for watching the eCard their in the context of some page.
When user perform some action on our website, we may want to create a widget that provide some additional benefit. And concept can be applied for a single website or cross websites. For example, let's assume we have affiliate website that drive traffic to web store. When user arrive from the affiliate website, perform a conversion, e.g make a purchase, the website start a process that create a widget in association with the origin website - the website of the affiliate. The widget may include a benefit or some occurrence that provide the user with added value. This way we can encourage users to shop through the affiliate website, knowing that once doing this they will get this "benefit". Click here for a sample use case.
Search Engine Advanced Engagement
Lets assume we have a web service with customers. For example we have a web store with customers that purchased in the store. We can use Content Glass Server Widgets API, on combine with Glass For Search application to present our customers with extended info. We can do that with Server Widgets API by creating a widget associated with search engine portal (e.g .google.com). The widget is associated with specific key words (the sharing context "state") and is shared with one or more of our customers.
When customer visit the search engine portal and search for match keywords, the widget is invoked with extended info and optionally a link targeting to provider's website. Of course when doing this we need to choose very carefully the target customers and the way we present the data/logic in the widget, since this is not intend to be an advertisement but an extended meaning to search engine result page (in terms of Glass For Search framework philosophy.)
Note: This feature is part of Glass of search framework that deals with the Content Glass running on search engine portals.
How is it working?
We will use the Card example from above to explain the concept. When eCard is created in the system of service providers, service provider send to Content Glass an HTTP request that define a widget need to be created on some website. The request contain some basic information such as:
- The page to share on (Glass ID)
- The type of widget to share
- The content to present, for example some HTML markup for showing the eCard in an iframe
- The email(s) of the peer(s) to share the eCard wit
Content Glass server-widgets API receive the request, create a widget in CG system, makes it related with specified webpage (or code) , assign a peers-group to the widget and store the widget records. Email is sent to target peers.
Widget is now ready to be shared.
Peers Group Management
The widgets created by the API are not public but shared with specific users as provided by request details. The entire peers-group relationship between provider's and target users is managed internally and automatically by Content Glass.
All that is required for provider is to register to the service, that will assign the provider with an account on Content Glass services portal. The account will be used as the "owner user" of created widgets. Peers with whom widgets are shared are referred by their Emails when sending the request for creating a widget.
The referred user may not have an account on Content Glass yet and may not have a relationship with the provider to allow the sharing. The new account and relation between provider's account and target user is automatically created by Content Glass upon acceptance of sharing invitation Email send automatically by user.
All that is required to do by service provider after initial registration, is to send a singe HTTP request for each widget need to be created. The sharing logic with all the required procedures is automatically handled.
To start using the API please refer to API documentation on developers website.
We encourage developers and service providers that would like to use the API to contac us by Email and present their need. We would love to help to establish working use case.