Document Annotation SDK for Ruby
Add Text, Area, Point, Polyline, Pointer, & Watermark Based Annotations to Documents of Various Formats Using Ruby Applications.Start Free Trial
GroupDocs.Annotation Cloud SDK for Ruby
The GroupDocs.Annotation Cloud for Ruby is a REST API that works as a document annotator and supports lots of popular file formats for your business document and image annotation operations. Through this set of APIs, Ruby developers can easily and efficiently create feature-rich online document annotation tools. GroupDocs.Annotation Cloud SDK for Ruby is readily customizable to suit your needs.
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
GIntegrating 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.