A.nnotate Integration API

It is possible to integrate the A.nnotate capabilities to provide a PDF / Word / Web annotation component within your own web applications. It can be used on the Pro, Group and Business hosted services as well as on standalone servers.

Enabling annotation on your web site

The simplest way to enable A.nnotate capability on your web pages is to add the A.nnotate buttons and links. This allows your users to keep private / shared notes on your web pages, and all you need to do is add a special link to each page.

Embedding an A.nnotate panel in your own web application

The Guide to embedding A.nnotate in your own application shows how you can include an iframe for displaying a PDF / Word document within your own web application. You can hide the A.nnotate banner and show your own icons / branding in its place. The interface is based on a simple HTTP GET API for specifying the PDF / Word document to display. Sample code is supplied in PHP, but you can use the API from any web programming language or framework (JSP / ASP / .net / Python / Perl etc)

In the pipeline...

We are currently working on extending the API to include:

  • Extracting the annotations in structured form
  • Integration with existing user authentication systems
  • Setting initial tag sets for curation tasks

Please contact us to discuss your project requirements as are very interested in hearing of requirements for connecting the A.nnotate system to existing applications and are looking to extend the API to support more applications. The current version of the API reference is now available; it includes sample code and can be used with a local installation of A.nnotate.