API Documentation

Overview

The yolink Web Services API provides the ability for applications and websites to integrate yolink functionality to empower a deeper level of search.

The API provides access to the cloud version of yolink to add powerful, real-time search capabilities to any application, and a set of configurable widgets which can easily be dropped into a page to provide dynamic search over top of existing content.

Applications wishing to integrate directly with the web services will find a complete breakdown of them here.

Applications wishing to interact with the API at a higher level may leverage the suite of embeddable widgets have a number of options. Each of these is composed of standards-based HTML, JavaScript and CSS and therefore requires no additional components be installed to run. Available options include,

• Embedded - a widget with no UI presence, but which may be embedded into the page to enhance search results. It may be configured to either automatically process the search, or trigger it based on some other UI action, and can be customized to present the results wherever and however is desired.

• Toolbar - a widget which presents the search as an in-page toolbar. This floating toolbar provides the user the ability to initiate a yolink search and interact with the various services provided by yolink to share and publish the results discovered. The toolbar is fully configurable and can be made to follow any look and feel.

• Form - a search form which can be used to trigger a yolink-enhanced search. The form widget is fully configurable and can be made to follow any look and feel.

Use Cases and Tutorials

Coming soon.

Technical Notes

Syntax

The yolink Web Services API utilizes Google's search syntax to ensure concise yet powerful search capabilities.

Supported File Types

• HTML, XHTML, XHTML2
• RSS
• Atom
• Plain Text (.txt)
• PDF

Supported Protocols

• http
• https
• ftp
• feed

Widget Compatibility

Widgets have been tested against the following browsers for compatibility.

• Internet Explorer 7, 8 (using Strict Mode)
• Firefox 3+
• Safari 4+
• Google Chrome 4+

Limitations

• Pages requiring HTTP Authentication may not work with the API.
• Pages requiring cookies to properly render may not work with the API because cookies may not be communicated to cloud.yolink.com.
• Pages behind a firewall, or generally not publicly accessible from cloud.yolink.com will not produce search results.
• Pages on FTP servers must either encode credentials in the URL or must allow anonymous access.