Let's Annotate in Ruby with RESTful API
REST API & Cloud SDK for Ruby to build online document & image annotation tools with support for text & image annotation options. Let's annotate!Start Free Trial
GroupDocs.Annotation Cloud SDK for Ruby
GroupDocs.Annotation Cloud SDK for Ruby RESTful APIs is all you need to build document annotator tools in Ruby. Your application will be able to add annotations, watermark overlays, text replacements, redactions, sticky notes and text markups to the business documents of all popular formats such as, PDF, Microsoft Word, Excel, PowerPoint, Outlook, images other formats. Rapidly develop Annotation applications in Ruby using our SDK that works as a wrapper around Ruby APIs and makes the solution cross-platform compatible. Support for 3rd party cloud storage providers, e.g., Amazon S3, Windows Azure, Dropbox and others is also provided.
GroupDocs.Annotation set of SDK REST APIs is not dependent on your local operating system or database. We offer our SDK APIs in numerous programming languages and with frequent new additions.
Ruby Gem is required for communicating with the GroupDocs.Annotation Cloud SDK API for Ruby.
Supported File Formats
GroupDocs.Annotation Cloud SDK APIs support following file formats:
- Word: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF
- Excel: XLS, XLSX
- PowerPoint: PPT, PPTX, PPSX
- Visio: VSD, VDX, VSS, VSX, VTX, VSDX, VSSX, VSDM, VSTM, VSSM
- Outlook: EML, EMLX, MSG
- OpenDocument: ODT, OTT, ODP, OTP
- Fixed Layout: PDF
- Image Files: BMP, PNG, JPG, JPEG, TIFF, TIF, GIF
- Web: MHTML
- Text: TXT
Advanced Document Annotation REST API Features
Support for Multiple File Formats
Import Annotation Information from Document & Return the List of Imported Annotations
Export/Add Annotation to a Document & Retrieve the Resultant Document as Stream
Render Document Pages to Images and Retrieve Images’ Links
Retrieve Link to Previously Generated Image by Page Number of Annotated Document
Render Document to PDF, Save Resultant Document to Storage & Fetch its Link
Render Document to PDF as an Output Stream
Add Text Redaction Annotation in Slides
Add Annotations to Header/Footer of Microsoft Word Documents
Integrating GroupDocs.Annotation Cloud SDK into your ruby applications is very easy. No installation is required on the server or client side. Just create an account at GroupDocs.CLOUD to get App SID & key. Following example shows how easy it is to import annotation information using Ruby:
Import Annotation Information - Ruby
# TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required). # For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby # Extracts annotations from document. def get_import @config = GroupDocsAnnotationCloud::Configuration.new(Utils::APP_SID, Utils::APP_KEY) @config.api_base_url = Utils::API_BASE_URL @filename = 'Annotated.pdf' @foldername = nil @annotation_api = GroupDocsAnnotationCloud::AnnotationApi.from_config(@config) request = GroupDocsAnnotationCloud::GetImportRequest.new(@filename,@foldername) # Extracts annotations from document. response = @annotation_api.get_import request puts response puts 'completed' end
Support for Numerous Annotation Types
Using GroupDocs.Annotation Cloud SDK for Ruby, you can work with diverse types of annotations. The two basic types are; Text Annotations and Figure Annotations.
While using text-based annotation, you can add text comments to selected text; highlight which text should be replaced with what, hide confidential text using text redaction, highlight text with strikethroughs/underlines, and add sticky notes with rich text.
While working with figure annotations, you can add notes to an area highlighted with a rectangle (Area Annotation), add notes to any point in the document (Point Annotation), hide confidential parts of an image or text (Area Redaction), draw freehand lines and shapes (Polyline), arrows pointing to an object (Pointer/Arrow), create text-based watermark overlays (Watermark), and measure the distance between any objects in a document (Distance Annotation).
GroupDocs.Annotation Cloud SDK for Ruby is 100% tested and out of the box running. The SDK is open source and has an MIT license. You can use it, and even customize it for absolutely free of charge.
Interactive API Explorer
Using our Swagger based API explorer; you can try out GroupDocs.Annotation Cloud SDK for Ruby right away in your browser. This interactive API explorer gives you information about all the resources that the API offers. You can also try your desired operation by interactively providing required parameters.
GroupDocs.Annotation Cloud Product Family also includes SDKs for other popular languages as listed below: